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.
>I am seeking advice and alternatives for documenting the same product that
>runs in multiple interfaces.
Most of the responses so far seem to deal more with using conditional
text for hard copy docs. What solutions would you propose for online
help?
A related question -- how would you handle documenting a product where
the customer can choose the work flow, thus changing the interface on
the fly?
For example, customer A configures the system so s/he enters an
order by
1. entering customer info.
2. checking if the customer owes past due invoices
3. entering the line item info
4. checking the credit for this order
5. releasing the order
Customer B configures the system so s/he enters an order by
1. entering customer info.
2. entering line item info
3. checking the credit for this order
4. checking if the customer owes past due invoices
5. releasing the order
This is just an example. Suppose the user has the ability to pick the
screen elements s/he needs and can drop them onto the screen. You
don't know which ones will be chosen -- just that some subset will be
picked. How do you document this?
Ruth
rglaser -at- nxtrend -dot- com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html