This is a read only archive of pad.okfn.org. See the
shutdown announcement
for details.
writethedocs-new-writers
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Learning technical writing
TECHNICAL WRITING HANDBOOK
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Is there anything like this already?
A Tech Documentarian's Handbook?
Resources for learning?
There should be!
a github repo
put it on ReadTheDocs
========================================
___Existing resources [curated list!]
Websites?
Books??
http://www.amazon.com/Technical-Documentation-Handbook-Software-Development/dp/155558103X
___How to start?
"Most open source projects are happy to find documentarians."
"Submit a fix / ticket on the project's github and go with that."
"Just install/use some project, and try to improve the process."
___Good examples of technical docs
http://www.mediawiki.org/wiki/Manual:Contents
...
___Tech to know
______Markups
xml
html
restructured text
mediawiki syntax
______Doc "frameworks"
Asciidoc
docbook (xml)
sphinx
DITA
...
______More cool tool
Hemingway
...
___How to get jobs?
???