How developers write documentation

How developers write documentation

Transcript

1. How developers code write @sengopal
2. What is Documentation
3. What is Documentation Material that provides official information or evidence or that serves as a record. Written specification and instructions accompanying a computer program.
4. Aspects READABILITY Available Offline No custom tools Standard Templates EDITOR Available Offline No custom tools Basic In built generators for TOC, tables etc., Reviews DISTRIBUTION Versioned Zero staleness Close to source of truth
5. Available Today https://xkcd.com/927/
6. Google Docs Microsoft Word Wiki O365 What’s the point of this presentation anyway?
7. GITHUB Available Offline No custom tools Versioned and Reviews Close to source of truth Zero staleness Templates - define your own! this ←
8. Lingua Franca MARKDOWN Released in 2004 Lightweight markup Plain text formatting Converted to HTML Readme files Online forums ASCIIDOC Released in 2002 Equivalent to DocBook Plain-text mark-up DocBook tool-chain PDF, TeX, manpages, e- books, slides, Git
11. Choice http://counterinception.com/sites/default/files/pictures/MatrixBluePillRedPill.jpg
12. Asciidoc Why book writers are switching to Asciidoc 1. Better UI control 2. Admonitions 3. Macros such as TOC 4. Env. Variables 5. Advanced Table support 6. Page Navigation 7. More…. Asciidoc Reference
13. My Toolset
14. Toolset Github Asciidoc AsciidocFx Atom/Chrome Plugin
15. Side Note Github Wiki Gollum Static Site Generators staticgen
16. Questions?