談談技術文檔的編寫
博客園里討論編程的文章很多，卻沒有見過誰發表過文檔撰寫方面的，或者有，是有我不知道呢？但無可否認的是，涉及到到文檔方面的極為罕見。這是否與程序員對文檔的編寫不夠重視有關呢。 作為一名程序員，我也曾經犯這樣的錯誤，對於文檔的編寫不夠重視。但是長期地和客戶接觸中，發現文檔的撰寫極為重要，出色文檔 ...
原文：關於文檔編寫
寫文檔的困惑 寫文檔不像寫代碼，它沒有明確的好與壞，更沒有明顯的正確與不正確。也正因為此，對於寫慣了代碼的程序員來說，寫文檔是無比痛苦的，完全找不着北。 寫短了，人家說沒寫清楚，太不詳細 寫得長了，人家說太瑣碎，那么長，哪有精力看。 領導說， 這個問題簡單，兩三頁隨便描述一下就行了。 你若真是只寫個兩三頁，百分之百挨批。 又要言簡意賅，又要表述詳盡。這比寫代碼要費勁多了。 我們寫代碼時，講什么重構 ...
2012-07-17 15:52 3 2206 推薦指數：
相關推薦
編寫用例文檔
繪制用例圖只是完成了用例建模最基本也是最簡單的一步，用例建模的核心在於編寫用例文檔，用例文檔又稱為用例規約或用例描述。顧名思義，用例文檔是用於描述用例的文檔，每一個用例對應於一個用例文檔，在用例文檔中需要用文字的方式描述用例的執行過程，即執行者與系統的交互過程。 用例文檔需要通俗易懂 ...
使用GitBook編寫文檔
GitBook 簡介 GitBook 是一個通過 Git 和 Markdown 來撰寫書籍的工具，最終可以生成 3 種格式： 靜態站點：包含了交互功能（例如搜索、書簽）的站點 PDF：P ...
Dockerfile文檔編寫
圖片顯示問題，附上有道雲筆記中鏈接：http://note.youdao.com/noteshare?id=fba6d2f53fd6447ba32c3b7accfeb89b&sub=B36B5904A0804AF5AD3194AAA196F8C3 編寫Dockerfile FROM指令 ...
基於 Markdown 編寫接口文檔
最近公司開發項目需要前后端分離，這樣話就設計到后端接口設計。復雜功能需要提供各種各樣的接口供前端調用，因此編寫API文檔非常有必要了 網上查了很多資料，發現基於Markdown編寫文檔是一種比較流行而且成熟的方案了，話不多說，我也搞一搞試試。 電腦操作系統：deepin深度 Linux64位 ...
基於typora編寫Markdown文檔
基於typora編寫Markdown文檔 作者：尹正傑 版權聲明：原創作品，謝絕轉載！否則將追究法律責任。 去年我有些過關於Markdown語法的文檔，今天我就來 ...
【文檔】使用Sphinx + reST編寫文檔
0 前言 寫文檔是開發人員日常工作中的一項重要內容，除了word之外，我更偏愛使用標記語言(Markup Language)。使用標記語言，可以利用簡單、免費的文本編輯器(記事本，vim, emacs...）編寫文檔並設置格式，再生成html或pdf等格式，或者直接把編輯好的文件傳到github ...
README.md文檔編寫
文章參考自：如何為開發項目編寫規范的README文件（windows），此文詳解 - 戰爭熱誠 - 博客園 (cnblogs.com) 為什么要寫這篇博客？ 其實我是一個入坑已經半年的程序員，因為不是計算機專業，只能自己摸索，所以我深知博客的重要性。每次我的學習筆記啊，項目的，面試題 ...