Markdown技術文檔編寫規范
Markdown技術文檔編寫規范 Markdown是一種可以使用普通文本編輯器編寫的標記語言，通過簡單的標記語法，它可以使普通文本內容具有一定的格式。 文檔體系 結構 簡介（Introduction）： [必備] [文件] 提供對產品和文檔本身的總體的、扼要 ...
原文：中文技術文檔寫作規范
使用 markdown 格式書寫文檔 只使用一二三級標題，三級標題下面的並列性內容使用列表展示 二級標題前使用行分隔符表示分隔 段落之間使用一個空行隔開 一句話或者以逗號分隔的句子，長度盡量保持在 個字以內， 個字的句子，可以接受 禁止文字口語化 盡量使用肯定句表達，不使用否定句表達 例如：沒有 不能 不可以 不使用 被 第一次出現英文詞匯時，在括號中給出中文標注 例如：IOC Internat ...
2021-12-14 10:53 0 138 推薦指數：
相關推薦
Javassist中文技術文檔
本文譯自Getting Started with Javassist，如果謬誤之處，還請指出。 bytecode讀寫 ClassPool Class loader 自 ...
學習一下阿里技術文檔的寫作方法
我覺得寫的挺好的，如果讓我寫一個技術文檔，我可能寫的沒有那么好，關鍵是學習一下寫作結構，我相信只要大的框架對的話，就算語言水平差強人意，同一個圈子里面的人也能理解技術文檔應該沒有什么障礙的。 https://antv.alipay.com/g2/doc/index.html 這是阿里的一個 ...
美賽論文寫作--寫作規范
一、段落和句子 1.寫作要使用簡短的段落，但是要避免出現只含有一兩個簡單句子的超短段落，如果論文中含有很多這樣的句子，就會使讀者頻繁停頓，影響閱讀的連貫性。 2.寫作時要盡可能的用簡單句，越簡單越好，一個句子僅需要表達一個意思。 3.要使用簡單的單詞和短語。例： 劣：Due ...
前端新技術中文文檔
nodejs中文網，官網同步翻譯 http://nodejs.cn/api/ Webpack 中文手冊（社區同步翻譯） http://6.course.uprogrammer.cn/webpack2-doc-cn/index.html ECMAScript6 中文教程 https ...
SQLAlchemy技術文檔（中文版）（全）
原文鏈接：http://www.cnblogs.com/iwangzc/p/4112078.html（感謝作者的分享） sqlalchemy 官方文檔：http://docs.sqlalchemy.org/en/latest/contents.html 1.版本檢查 import ...
SQLAlchemy技術文檔（中文版）（上）
在學習SQLAlchemy的過程中，好多時候需要查官方Tutorial，發現網上並沒有完整的中文版，於是利用這兩天空余時間粗略翻譯了一下。 翻譯效果很差。。。。但也算是強迫自己通讀一遍Tutorial，收獲很多。 1.版本檢查 import sqlalchemy ...