[liberationtech] Good examples of software documentation?

2013-02-11 Thread adrelanos
Hi, since I want to write good documentation for my own project, I thought it may be worth checking how other projects did. Which project/documentation do you personally enjoy? Bonus points for anonymity/privacy/security related projects. Which medium is preferred? Text, text with lots of

Re: [liberationtech] Good examples of software documentation?

2013-02-11 Thread Griffin Boyce
As a user, I prefer text with screenshots. As a coder, I'm okay with just text. Video is good for showing off the finished product, but not as good for showing how to implement something. (It's a bit of an amusing problem where someone will youtube a solution to a really common problem. :D So

Re: [liberationtech] Good examples of software documentation?

2013-02-11 Thread danimoth
On 11/02/13 at 10:20am, adrelanos wrote: Hi, since I want to write good documentation for my own project, I thought it may be worth checking how other projects did. Which project/documentation do you personally enjoy? Bonus points for anonymity/privacy/security related projects. It

Re: [liberationtech] Good examples of software documentation?

2013-02-11 Thread adrelanos
danimoth: On 11/02/13 at 10:20am, adrelanos wrote: Hi, since I want to write good documentation for my own project, I thought it may be worth checking how other projects did. Which project/documentation do you personally enjoy? Bonus points for anonymity/privacy/security related projects.

Re: [liberationtech] Good examples of software documentation?

2013-02-11 Thread Brian Conley
Hi Adrelanos, At SWN we have been writing a lot of documentation, training, and other materials in the last 18 months, including a soon-to-be published 40,000 word curriculum in journalism, mobile safety, and multimedia production. What I find works best are: 1. active voice sentences whenever