What nobody tells you about documentation - Blog - Divio
The Grand Unified Theory of Documentation – David Laing There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four. They are: tutorials, how-to guides, technical reference and explanation. They represent four different purposes or functions, and require four different approaches to their creation. Understa
質ã®é«˜ã„技術文書を書ã方法 - As a Futurist...
大å¦ã‚„大å¦é™¢ã§è«–æ–‡ã®æ›¸ã方をé›ãˆä¸Šã’ãŸäººãŸã¡ã«ã¯é ãé ãåŠã°ãªã„ãŒã€åƒ•ã®æ§˜ãªã¯ãれもã®1ã§ã‚‚最近㯠Amazon 社内ã§æ–‡æ›¸ã®è³ªãŒé«˜ã„ã¨è©•ä¾¡ã—ã¦ã‚‚らãˆã‚‹ã¾ã§ã«ã¯ãªã£ãŸã€‚Software Engineer ã¨ã—ã¦ã€ã‚³ãƒ¼ãƒ‰ã§ã®ã‚¢ã‚¦ãƒˆãƒ—ットã¯ã‚‚ã¡ã‚ん大事ã ã‘ã©ã€æ–‡æ›¸ã®ã‚¢ã‚¦ãƒˆãƒ—ット(ãŠã‚ˆã³ãã‚Œã«ã‚ˆã£ã¦å¾—られãŸå®Ÿéš›ã®ã‚¢ã‚¦ãƒˆãƒ—ット)ã¯åŒã˜ã ã‘é‡è¦ã§ã‚ã‚‹2。今回ã¯è‡ªåˆ†ãŒæœ€è¿‘ã©ã†ã„ã†ã¨ã“ã‚ã«æ°—ã‚’ã¤ã‘ã¦æŠ€è¡“文書を書ã„ã¦ã„ã‚‹ã®ã‹ã€ã¨ã„ã†ã“ã¨ã«ã¤ã„ã¦æ•°å¹´å¾Œã®è‡ªåˆ†ãŒå¿˜ã‚Œã¦ãªã„ã“ã¨ã‚’確ã‹ã‚られる様ã«ã¾ã¨ã‚ã¦ãŠã。 ãã‚‚ãも文書ã¨ã¯ï¼Ÿ 英語ã 㨠document。ã“ã“ã§æŒ‡ã™(技術)文書ã¨ã¯ã€äººé–“ãŒèªã‚€æ–‡ä½“ã§æ›¸ã‹ã‚ŒãŸæŠ€è¡“ã«é–¢é€£ã™ã‚‹æƒ…å ±ã€ã¨ã„ã£ãŸã‚‚ã®ã 。具体的ã«è¨€ã†ã¨ä»¥ä¸‹ã®æ§˜ãªã‚‚ã®ã‚’想定ã—ã¦ã„ã‚‹: æ–°ã—ã„プãƒã‚¸ã‚§ã‚¯ãƒˆã®éª¨åを説明ã™ã‚‹è³‡æ–™ 会è°ã®å©ãå°ã¨ãªã‚‹ 1 枚ペラ 本番環境ã«å¤‰æ›´ã‚’åŠ ãˆã‚‹ã«ã‚ãŸã£ã¦ã®åŒ…括的ãªæƒ…å ±ã‚„å…·ä½“
1
ランã‚ング
ãŠçŸ¥ã‚‰ã›
ランã‚ング
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
処ç†ã‚’実行ä¸ã§ã™
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}