Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.forth > #28105

Re: [OT?] Would journalists be preffered documenters?

Show all headers | View raw

Richard Owlett wrote:

> Documentation is a recurring topic on this group
> 
> On a Linux distribution specific list I've been unsuccessfully
> asking questions.
> No matter how I phrase the questions, I keep get answers to "HOW".
> 
> Back in the 50's, I was taught that there were also 5 W's:
>    Who  What  When Where  Why
> 
> I think quality/useful documentation should cover at least
>    What When Why
> 
> Anyone know of a documentation project with that POV?
> 
> Thank you for your time.
> If any think off-list response is best, y address is valid - if
> well filtered.
> 
> Thank you for your time.

Only all the major projects I have dealt with Richard. Then, my industry 
sectors, being mainly in the Safety Critical domains, has expended time and 
money to getting the documentation right. For the task the companies 
concerned usually hired Tech Authors. I thought I rote fairly good 
documentation myself but the best Tech Authors could make it seem like you 
were coming to the system afresh when you read their stuff (based on what I 
and other team mebers had written).

-- 
********************************************************************
Paul E. Bennett IEng MIET.....<email://Paul_E.Bennett@topmail.co.uk>
Forth based HIDECS Consultancy.............<http://www.hidecs.co.uk>
Mob: +44 (0)7811-639972
Tel: +44 (0)1235-510979
Going Forth Safely ..... EBA. www.electric-boat-association.org.uk..
********************************************************************

Back to comp.lang.forth | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[OT?] Would journalists be preffered documenters? Richard Owlett <rowlett@pcnetinc.com> - 2014-01-25 11:52 -0600
  Re: [OT?] Would journalists be preffered documenters? Paul E Bennett <Paul_E.Bennett@topmail.co.uk> - 2014-01-26 10:30 +0000
  Re: [OT?] Would journalists be preffered documenters? trebor.english@gmail.com - 2014-01-26 10:40 -0800
  Re: [OT?] Would journalists be preffered documenters? "Elizabeth D. Rather" <erather@forth.com> - 2014-01-26 12:47 -1000
  Re: [OT?] Would journalists be preffered documenters? anton@mips.complang.tuwien.ac.at (Anton Ertl) - 2014-01-27 14:51 +0000
  Re: [OT?] Would journalists be preffered documenters? Matthias Koch <matthias.koch@hot.uni-hannover.de> - 2014-01-28 10:40 +0100

csiph-web