How developers code write@sengopal

What is Documentation

What is DocumentationMaterial that provides official information or evidence

or that serves as a record.

Written specification and instructions accompanying a computer program.

Aspects

READABILITYAvailable Offline

No custom tools

Standard Templates

EDITORAvailable Offline

No custom tools

Basic In built generators for TOC,

tables etc.,

Reviews

DISTRIBUTIONVersioned

Zero staleness

Close to source of truth

Available Todayhttps://xkcd.com/927/

Google Docs

Microsoft Word

Wiki

O365

What’s the point of this presentation anyway?

GITHUBAvailable Offline

No custom tools

Versioned and Reviews

Close to source of truth

Zero staleness

Templates - define your own!

this←

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

Choicehttp://counterinception.com/sites/default/files/pictures/MatrixBluePillRedPill.jpg

AsciidocWhy 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

My Toolset

ToolsetGithub

Asciidoc

AsciidocFx

Atom/Chrome Plugin

Side Note

GithubWikiGollum

Static Site Generators

staticgen

Questions?