Slide 1

Slide 1 text

How developers code write @sengopal

Slide 2

Slide 2 text

What is Documentation

Slide 3

Slide 3 text

What is Documentation Material that provides official information or evidence or that serves as a record. Written specification and instructions accompanying a computer program.

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

Available Today https://xkcd.com/927/

Slide 6

Slide 6 text

Google Docs Microsoft Word Wiki O365 What’s the point of this presentation anyway?

Slide 7

Slide 7 text

GITHUB Available Offline No custom tools Versioned and Reviews Close to source of truth Zero staleness Templates - define your own! this ←

Slide 8

Slide 8 text

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

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

Choice http://counterinception.com/sites/default/files/pictures/MatrixBluePillRedPill.jpg

Slide 12

Slide 12 text

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

Slide 13

Slide 13 text

My Toolset

Slide 14

Slide 14 text

Toolset Github Asciidoc AsciidocFx Atom/Chrome Plugin

Slide 15

Slide 15 text

Side Note Github Wiki Gollum Static Site Generators staticgen

Slide 16

Slide 16 text

Questions?