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.
Carrie Baker wrote:
> The programmer is working in C++ and has created an html
> file that is automatically generated, listing all of the
> classes and commands
Find out how he/she is generating this html file. Probably doxygen, or
something from his IDE. Then, make sure he is commenting everything
with the correct comment tags so the comments are included in the
generated documentation. You should make it your business to learn the
capabilities of the generation tool so you can make sure your developer
adds comments to everything that should be commented - all classes and
functions to start with. Then you can work on editing the comments.
> what they are comprised of and what they do.
> (I have checked the English).
*head explodes*
> Do I need to copy all of this information to also create
> a PDF file (my source would be Frame for this) so there will
> be an "SDK User Guide", or is the integrated html considered
> sufficient?
The HTML should be enough. If you have a print requirement, again, look
at the capabilities of the auto-generation tool.
> What should I learn to be able to write about this better?
SDK docs should include a programmer's guide, which is really just
another kind of user guide. And like any other user guide, find out
what your users need to know, and then write it. Try asking your
developers for the top ten tasks a programmer would need to do with the
SDK, and then start asking questions and documenting those tasks. Or
ask for the most commonly used functions, and then ask for examples of
how they are used.
Mike O.
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
