TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
We should stay in closer contact, because VxWorks BSP documentation is
part of my new documentation assignment. Just yesterday I learned about
refgen after submitting a trouble ticket. (You'd think that there'd be
an index entry for "HTML," "documentation (generation)," "code
comments," "comments," etc. that could get some BSP ignorant person like
myself to Appendix D where refgen is buried with nary an index entry.)
If I find myself faced with the same problem, what I'll do is put a
special tag into the comments that references an external file (like a
GIF). I'll update my tools that do post-processing to turn that into a
duly qualified HTML href.
By the way, I recently got permission to open-source my post-processing
tools (Perl, Unix Shell scripts, and HTML). I'll be happy to blast you a
copy.
I will be updating my tools to process the refgen HTML files to create
TOC and index tokens. I need to wrap this HTML output into a bigger
system comprised of mini-HTML systems coming from Doxygen (other code
areas) and FrameMaker/Mif2Go (where overview, how-to stuff is).
In fact, if I'm confronted with the diagrams that you suggest, I will be
putting them into the FrameMaker files and not in the code where the
code reference material is.
Glenn Maxey
Technical Writer
Voyant Technologies, Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301
Tel. +1 303.223.5164
Fax. +1 303.223.5275
glenn -dot- maxey -at- voyanttech -dot- com
> -----Original Message-----
> From: Dave Neufeld [mailto:Dave_Neufeld -at- spectrumsignal -dot- com]
> Sent: Friday, January 25, 2002 11:59 AM
> To: TECHWR-L
> Subject: Seeking VxWorks BSP Documentation advice
>
>
> Has/is anyone else out there dealing with VxWorks BSP documentation?
>
> (If you don't know what VxWorks BSP Documentation is, please
> ignore this post.)
>
> Anyhow, we're creating several VxWorks BSPs and I want tech
> writers to move further upstream in the generated
> documentation and take over some of the documenting that the
> developers are doing.
>
> ======================================================================
> MY QUEST: Is there a s/w tool/utility that generates ASCII
> character diagrams from traditional line art? See example at
> the end of this post...
> ======================================================================
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
