产品文档 & 技术文档书写教程 All In One

产品文档 & 技术文档书写教程 All In One

Software Engineering at Google

SWE

https://abseil.io/resources/swe-book

https://abseil.io/resources/swe-book/html/toc.html

Documentation

https://abseil.io/resources/swe-book/html/ch10.html

https://github.com/wuzhouhui/misc/blob/master/OReilly.Software.Engineering.at.Google.2020.3.pdf

谷歌软件工程 中文版 pdf

https://github.com/xgqfrms/Software-Engineering-At-Google/blob/main/docs/ch10-documentation.md

Google developer documentation style guide

谷歌开发者文档风格指南

https://developers.google.cn/style

中文技术文档的写作规范。

目录
标题
文本
段落
数值
标点符号
文档体系
参考链接

https://www.ruanyifeng.com/blog/2016/10/document_style_guide.html
https://github.com/ruanyf/document-style-guide

技术文档

每个产品和项目管理团队都需要关键人物来创建和管理各种技术文档项目。

什么是技术写作？

技术文档以各种形式和格式存在，尽管它现在大多在网上提供。
尽管技术文档通常是由技术作家、开发团队、项目经理、开发人员和其他行业的专业人士创建的，但最好的技术文档能够简单、清晰地传达信息，使每个人都能理解。
否则，它就达不到其预期的功能。

技术文档是指详细说明产品特性和功能的文件。
它在软件开发行业中最经常被开发和产品团队开发，并可能被用来解决组织内各利益相关者的支持需求。

它们为与产品有关的项目提供背景。
无论是描述产品的用法、技术、功能、特点还是开发，其最终目的都是为了让读者了解产品的某个特定元素。
无论它们是被用于软件开发、产品开发还是其他领域，都是如此。

https://www.docsie.io/blog/zh/articles/how-to-write-amazing-technical-documentation/

https://help.docsie.io/?doc=/publish-documentation-portal/docsie-styling-guide

GitHub Flavored Markdown Spec

GFM 规范

GitHub 风格的 Markdown 规范

https://github.github.com/gfm/

http://gfm.docschina.org/zh-hans/

PRD 文档

PRD 定义

PRD 作用

PRD & MRD & BRD

产品需求文档
市场需求文档
商业需求文档

三者关系图

https://www.imooc.com/learn/1318

refs

https://zh-style-guide.readthedocs.io/_/downloads/zh_CN/latest/pdf/

https://segmentfault.com/a/1190000040409082

https://www.cnblogs.com/xiaozhi_5638/p/15847859.html

https://www.zhihu.com/question/19945828

https://www.docsimpo.work/technical-writing/style-guides.html

https://www.51cto.com/article/711426.html

https://sspai.com/post/68349

---

---

©xgqfrms 2012-2020

www.cnblogs.com/xgqfrms 发布文章使用：只允许注册用户才可以访问！

原创文章，版权所有©️xgqfrms, 禁止转载 🈲️，侵权必究⚠️！

---