On 05/21/16, Tony Langdon pondered and said...

Yes, writing good documentation is HARD. It tkes someone who knows the product, has great attention to detail and excellent verbal thinking. I fall down on the latter, verbal is not my natural mode. :)

Insightful and interesting comments to read - thanks for posting .

--- Mystic BBS v1.12 A14 (Windows)
* Origin: Agency BBS | telnet://agency.bbs.geek.nz (3:770/100)
þ Synchronet þ Vertrauen þ Home of Synchronet þ telnet://vert.s

Paul Hayton wrote to Tony Langdon <=-

On 05/21/16, Tony Langdon pondered and said...

Yes, writing good documentation is HARD. It tkes someone who knows the product, has great attention to detail and excellent verbal thinking. I fall down on the latter, verbal is not my natural mode. :)

Insightful and interesting comments to read - thanks for posting .

There is a bit of practical experience in there. When I had to write documentation for work, I'd get someone else to follow my instructions verbally, explaining my thinking along the way, and he'd translate that into written instructions. And as he was actually doing the actions, he'd get to see what happened and could add that to each step.

That way, I could see the results of each step, point out important things along the way and we could decide what needed to be included, and what could be left out, or at least relegated to a note of lesser importance.


... Hold on a sec. A cat is tugging at my heartstrings.
--- MultiMail/Win32 v0.49
* Origin: Freeway BBS - freeway.apana.org.au (3:633/410)
þ Synchronet þ Vertrauen þ Home of Synchronet þ telnet://vert.synchro.net