Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

How developers write documentation

Avatar for Senthilkumar Gopal Senthilkumar Gopal
March 18, 2020
Programming
44
0

How developers write documentation

How developers write documentation

Avatar for Senthilkumar Gopal

Senthilkumar Gopal

March 18, 2020

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
530
Paper Review of ConvNext
Avatar for Senthilkumar Gopal sengopal
0
230
Portfolio for CS 6475 Computational Photography
Avatar for Senthilkumar Gopal sengopal
0
73
Our Agile Pursuit of Happyness
Avatar for Senthilkumar Gopal sengopal
0
1.9k
Token based API Security
Avatar for Senthilkumar Gopal sengopal
0
490
Resiliency using Hystrix
Avatar for Senthilkumar Gopal sengopal
0
130
BDD using Cucumber
Avatar for Senthilkumar Gopal sengopal
0
140
Introduction to Git and Github
Avatar for Senthilkumar Gopal sengopal
0
170
Introduction to Responsive Web Design
Avatar for Senthilkumar Gopal sengopal
0
78

Other Decks in Programming

See All in Programming
HTML-in-Canvasで作る未来のWeb UI表現
Avatar for IKEDA Yasunobu clockmaker
3
4.2k
UnityでSystem.Net.WebSocketsなWebSocketサーバが動かないのでUnity Monoのコードを覗いてみた / about implementing websocket server with unity mono
Avatar for にー兄さん drumath2237
1
580
AWS CDKのカスタムリソースでContinuum（旧Security Agent）を実装した話 | Implementing Continuum (formerly Security Agent) via AWS CDK Custom Resource
Avatar for アキキー | Akihisa Ikeda akihisaikeda
2
150
Kubernetes祭り #2 OP/ED
Avatar for bells17 bells17
0
110
技術的負債の返済は、AI時代の複利で効く投資 — 経営としての意思決定とその遂行
Avatar for curekoshimizu curekoshimizu
1
2.3k
更なる可用性を求めて、5年間運用したKotlinのアプリケーションをGoでリプレイスする話
Avatar for Kensuke Taguchi ken_tunc
0
550
Simple Storage Service(S3) is not simple
Avatar for Yura Iwatsuka iwatsukayura
0
250
Ghostty + Neovimで作る 透明でカッコ良い開発環境
Avatar for Kanade Nonomura j341nono
0
160
コードで差別化できない時代の ソフトウェアエンジニアリング / Software Engineering in an Era Where Code Doesn’t Differentiate
Avatar for Naoki Kishida kishida
2
150
setup-vp GitLab対応の裏側
Avatar for Naoki Haba naokihaba
0
160
ソニーのクラウド共通基盤の変遷と AI時代の開発スタイルに合わせた進化 / The Journey of Sony’s Common Cloud Platform and Its Evolution for AI-Native Development
Avatar for KenjiYoneyama kenjiyoneyama
0
250
Jetpack Compose Mechanisms
Avatar for Jaewoong skydoves
2
700

Featured

See All Featured
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
Avatar for soudai sone soudai
PRO
203
77k
16th Malabo Montpellier Forum Presentation
Avatar for AKADEMIYA2063 akademiya2063
PRO
0
400
Practical Tips for Bootstrapping Information Extraction Pipelines
Avatar for Matthew Honnibal honnibal
25
2.1k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
Avatar for Vitaly Friedman smashingmag
254
22k
We Have a Design System, Now What?
Avatar for Morgane Peng morganepeng
55
8.4k
Self-Hosted WebAssembly Runtime for Runtime-Neutral Checkpoint/Restore in Edge–Cloud Continuum
Avatar for Yuki Nakata chikuwait chikuwait
0
880
Accessibility Awareness
Avatar for Sarah Abderemane sabderemane
1
240
StorybookのUI Testing Handbookを読んだ
Avatar for Shingo Yamazaki zakiyama
31
7k
Art, The Web, and Tiny UX
Avatar for Lynn Fisher lynnandtonic
304
22k
What the history of the web can teach us about the future of AI
Avatar for Ines Montani inesmontani
PRO
2
730
Applied NLP in the Age of Generative AI
Avatar for Ines Montani inesmontani
PRO
4
2.5k
Pawsitive SEO: Lessons from My Dog (and Many Mistakes) on Thriving as a Consultant in the Age of AI
Avatar for David Carrasco davidcarrasco
0
260

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?