Upgrade to Pro — share decks privately, control downloads, hide ads and more …

How developers write documentation

Sponsored · SiteGround - Reliable hosting with speed, security, and support you can count on. →
Avatar for Senthilkumar Gopal Senthilkumar Gopal
March 18, 2020
Programming
0
33

How developers write documentation

How developers write documentation

Avatar for Senthilkumar Gopal

Senthilkumar Gopal

March 18, 2020
Tweet

More Decks by Senthilkumar Gopal

See All by Senthilkumar Gopal
Scaling ML embedding models to serve a billion queries
Avatar for Senthilkumar Gopal sengopal
0
450
Paper Review of ConvNext
Avatar for Senthilkumar Gopal sengopal
0
190
Portfolio for CS 6475 Computational Photography
Avatar for Senthilkumar Gopal sengopal
0
53
Our Agile Pursuit of Happyness
Avatar for Senthilkumar Gopal sengopal
0
1.9k
Token based API Security
Avatar for Senthilkumar Gopal sengopal
0
450
Resiliency using Hystrix
Avatar for Senthilkumar Gopal sengopal
0
92
BDD using Cucumber
Avatar for Senthilkumar Gopal sengopal
0
110
Introduction to Git and Github
Avatar for Senthilkumar Gopal sengopal
0
130
Introduction to Responsive Web Design
Avatar for Senthilkumar Gopal sengopal
0
60

Other Decks in Programming

See All in Programming
Fragmented Architectures
Avatar for Denys Poltorak denyspoltorak
0
150
今こそ知るべき耐量子計算機暗号(PQC)入門 / PQC: What You Need to Know Now
Avatar for mackey0225 mackey0225
3
370
AgentCoreとHuman in the Loop
Avatar for Har1101 har1101
5
230
HTTPプロトコル正しく理解していますか？ 〜かわいい猫と共に学ぼう。ฅ^•ω•^ฅ ﾆｬ〜
Avatar for ♛Heitor Hirose hekuchan
2
680
20260127_試行錯誤の結晶を1冊に。著者が解説 先輩データサイエンティストからの指南書 / author's_commentary_ds_instructions_guide
Avatar for nash_efp nash_efp
1
940
登壇資料を作る時に意識していること #登壇資料_findy
Avatar for konifar konifar
4
1k
なぜSQLはAIぽく見えるのか/why does SQL look AI like
Avatar for florets1 florets1
0
450
プロダクトオーナーから見たSOC2 _SOC2ゆるミートアップ#2
Avatar for Kenta Suzuki kekekenta
0
200
疑似コードによるプロンプト記述、どのくらい正確に実行される？
Avatar for kokuyouwind kokuyouwind
0
380
Spinner 軸ズレ現象を調べたらレンダリング深淵に飲まれた #レバテックMeetup
Avatar for 弁護士ドットコム bengo4com
1
230
FOSDEM 2026: STUNMESH-go: Building P2P WireGuard Mesh Without Self-Hosted Infrastructure
Avatar for Date Huang tjjh89017
0
160
生成AIを使ったコードレビューで定性的に品質カバー
Avatar for Chiaki Okamoto chiilog
1
260

Featured

See All Featured
What’s in a name? Adding method to the madness
Avatar for The Alliance productmarketing
PRO
24
3.9k
The Straight Up "How To Draw Better" Workshop
Avatar for Dennis Kardys denniskardys
239
140k
Stewardship and Sustainability of Urban and Community Forests
Avatar for Eric Wiseman pwiseman
0
110
How to make the Groovebox
Avatar for あそなす asonas
2
1.9k
The Illustrated Guide to Node.js - THAT Conference 2024
Avatar for David Neal reverentgeek
0
250
Everyday Curiosity
Avatar for Cassini Nazir cassininazir
0
130
The agentic SEO stack - context over prompts
Avatar for schlessera schlessera
0
630
Side Projects
Avatar for Sacha Greif sachag
455
43k
Information Architects: The Missing Link in Design Systems
Avatar for Michelle Chin soysaucechin
0
770
The SEO Collaboration Effect
Avatar for Kristina Bergwall kristinabergwall1
0
350
Mind Mapping
Avatar for Hélio Medeiros helmedeiros
PRO
0
78
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
Avatar for mongodb mongodb
49
9.9k

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
  9. None
  10. None

  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?