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.
(And sorry if you get this multiple times; I am asking this on several listservs.)
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.
People are rightly concerned that the syntax descriptions (especially the placeholders) arenât that easy to follow, and Iâve been asked whether thereâs perhaps some visual way to make the connection between the <placeholder> and its explanation (which is in a long bulleted âWhereâ list that follows the command syntax line)?
I donât have any ideas right off, so I thought Iâd ask to see if anyone had suggestions and particularly anything online to point to as a non-traditional way to document command syntax?
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-
