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.
It always reminded me of diagramming sentences in 9th grade English class.
But I think there is value in this presentation, along with examples, of
course.
Suzanne Chiles
On Thu, Nov 17, 2011 at 12:57 PM, Monique Semp
<monique -dot- semp -at- earthlink -dot- net>wrote:
> Hello, writers,
>
> I’m documenting the syntax for lots of commands that have fairly complex
> and inconsistent syntax: some have key-value pairs (and so I document the
> “value” portion as a placeholder indicated with italic code font within
> angle brackets), some have both required and optional parameters, sometimes
> the parameters are denoted by switches instead of key-value pairs – in
> short, all the usual inconsistencies of a big set of commands that’s grown
> over time under lots of developers.
>
> --
Suzanne Chiles
suzchiles -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
