Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
How developers write documentation
Search
Senthilkumar Gopal
March 18, 2020
Programming
0
25
How developers write documentation
How developers write documentation
Senthilkumar Gopal
March 18, 2020
Tweet
Share
More Decks by Senthilkumar Gopal
See All by Senthilkumar Gopal
Scaling ML embedding models to serve a billion queries
sengopal
0
270
Paper Review of ConvNext
sengopal
0
130
Portfolio for CS 6475 Computational Photography
sengopal
0
24
Our Agile Pursuit of Happyness
sengopal
0
1.8k
Token based API Security
sengopal
0
370
Resiliency using Hystrix
sengopal
0
49
BDD using Cucumber
sengopal
0
57
Introduction to Git and Github
sengopal
0
88
Introduction to Responsive Web Design
sengopal
0
48
Other Decks in Programming
See All in Programming
破壊せよ!データ破壊駆動で考えるドメインモデリング / data-destroy-driven
minodriven
4
430
Universal Linksの実装方法と陥りがちな罠
kaitokudou
1
200
Jakarta EE as Seen Trough the Lens of the ASF
ivargrimstad
0
950
CSC305 Lecture 13
javiergs
PRO
0
110
cgroup v2 support in Kubeadm
kentatada
0
220
watsonx.ai Dojo #3 プロンプトエンジニアリング入門
oniak3ibm
PRO
0
460
もう実家に手頃な情シス娘は不要!Bedrockでもう一人の娘を作る
komakichi
2
160
CSC305 Lecture 09
javiergs
PRO
0
120
書籍『LangChainとLangGraphによるRAG・AIエージェント[実践]入門』の紹介
os1ma
2
130
Re:proS_案内資料
rect
0
210
いかにして不足・不整合なくデータ移行したか
tjmtmmnk
1
970
Vaporモードを大規模サービスに最速導入して学びを共有する
kazukishimamoto
3
3.2k
Featured
See All Featured
A better future with KSS
kneath
237
17k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
43
6.6k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
159
15k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
4
260
The Language of Interfaces
destraynor
154
24k
Designing for Performance
lara
604
68k
StorybookのUI Testing Handbookを読んだ
zakiyama
26
5.2k
We Have a Design System, Now What?
morganepeng
50
7.2k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
126
18k
Rebuilding a faster, lazier Slack
samanthasiow
79
8.6k
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3.5k
Faster Mobile Websites
deanohume
304
30k
Transcript
How developers code write @sengopal
What is Documentation
What is Documentation Material that provides official information or evidence
or that serves as a record. Written specification and instructions accompanying a computer program.
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
Available Today https://xkcd.com/927/
Google Docs Microsoft Word Wiki O365 What’s the point of
this presentation anyway?
GITHUB Available 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
None
None
Choice http://counterinception.com/sites/default/files/pictures/MatrixBluePillRedPill.jpg
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
My Toolset
Toolset Github Asciidoc AsciidocFx Atom/Chrome Plugin
Side Note Github Wiki Gollum Static Site Generators staticgen
Questions?