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
30
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
410
Paper Review of ConvNext
sengopal
0
180
Portfolio for CS 6475 Computational Photography
sengopal
0
40
Our Agile Pursuit of Happyness
sengopal
0
1.9k
Token based API Security
sengopal
0
440
Resiliency using Hystrix
sengopal
0
82
BDD using Cucumber
sengopal
0
93
Introduction to Git and Github
sengopal
0
120
Introduction to Responsive Web Design
sengopal
0
59
Other Decks in Programming
See All in Programming
Android16 Migration Stories ~Building a Pattern for Android OS upgrades~
reoandroider
0
130
EMこそClaude Codeでコード調査しよう
shibayu36
0
310
Go言語の特性を活かした公式MCP SDKの設計
hond0413
1
430
コードとあなたと私の距離 / The Distance Between Code, You, and I
hiro_y
0
190
3年ぶりにコードを書いた元CTOが Claude Codeと30分でMVPを作った話
maikokojima
0
610
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
550
Flutterで分数(Fraction)を表示する方法
koukimiura
0
140
AI駆動で0→1をやって見えた光と伸びしろ
passion0102
1
760
TransformerからMCPまで(現代AIを理解するための羅針盤)
mickey_kubo
5
2.6k
CSC509 Lecture 08
javiergs
PRO
0
230
AIと人間の共創開発!OSSで試行錯誤した開発スタイル
mae616
2
770
チームの境界をブチ抜いていけ
tokai235
0
210
Featured
See All Featured
Documentation Writing (for coders)
carmenintech
75
5.1k
StorybookのUI Testing Handbookを読んだ
zakiyama
31
6.2k
RailsConf 2023
tenderlove
30
1.3k
Done Done
chrislema
185
16k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
4k
The Cost Of JavaScript in 2023
addyosmani
55
9.1k
Raft: Consensus for Rubyists
vanstee
140
7.2k
The Cult of Friendly URLs
andyhume
79
6.6k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
26
3.1k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
127
54k
Navigating Team Friction
lara
190
15k
A better future with KSS
kneath
239
18k
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?