This word list covers style and usage guidelines that are specific to developer documentation. If the term that you're looking for isn't on this list, check our other editorial resources, including our preferred dictionary, Merriam-Webster. If there are multiple spellings in the Merriam-Webster...
Don't try to write exactly the way you speak; you probably speak more colloquially and verbosely than you should write, at least for developer documentation. But aim for a conversational tone rather than a formal one. Don't try to be super-entertaining, but also don't aim for super-dry...
The Chicago Manual of Style Online University of Oxford Style Guide Google developer documentation style guide⭐️ Microsoft Writing Style Guide 其中,我最常使用的就是Google developer documentation style guide了,也强烈推荐给大家。 在日常协作中,有时需要给其他小伙伴解释某个技术写作规则,通常都能在 Goo...
docguide: Fix a typo Jan 17, 2025 go go: Export the latest version of internal guide. (#840) Jul 16, 2024 include Remove prettyprint from HTML/CSS Style Guide Jan 12, 2022 CODE_OF_CONDUCT.md use the 2.0 version of the Contributor Covenant, with modification ...
[TOC]documentation. ## Topic: The rest of your headings should start from level 2. ## See also: Put miscellaneous links at the bottom for the user who wants to know more or didn't find what she needed. Character line limit Obey projects' character line limit wherever possible. Long URLs...
Google Developer Documentation Style Guide 中文翻译版 see https://developers.google.com/style/ - dream-mind/google-developer-style
技术文档(Technical Documentation) 技术文档与代码一样应该得到开发者同等的重视,但有太多文档与代码不同步的场景出现,导致文档的可用性大大降低。为什么会出现这种问题?一方面是因为开发者重视度不够的问题,另外一方面是因为写一份好的技术文档并不是一件简单的事情。 如何写一份好的技术文档?推荐阅读如下的文章: Tec...
https://github.com/xgqfrms/Software-Engineering-At-Google/blob/main/docs/ch10-documentation.mdGoogle developer documentation style guide谷歌开发者文档风格指南 https://developers.google.cn/style中文技术文档的写作规范。目录 标题 文本 段落 数值 标点符号 文档体系 参考链接...
interesset. See the [foo docs](https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md). 1. 2. 3. 4. 5. 通常在长链接前新起一行有利于可读性,并且能够最小化链接的溢出。 Lorem ipsum dolor sit amet. See the [foo docs](https://gerrit.googlesource.com/gitiles/+/master/...
A function or destructor markedoverrideorfinalthat is not an override of a base class virtual function will not compile, and this helps catch common errors. The specifiers serve as documentation; if no specifier is present, the reader has to check all ancestors of the class in question to det...