Documentation Best Practices “Say what you mean, simply and directly.” - [Brian Kernighan] (https://en.wikipedia.org/wiki/The_Elements_of_Programming_Style) Contents: 1. Minimum viable documentation Delete dead documentation 4. Documentation is the story of your code Minimum viable documentation A small set of fresh and accurate docs are better than a sprawling, loose assembly of “documentation” in various guidelines. • Delete cruft frequently and in small batches. Update docs with code Change your documentation in the same CL as the code change. This keeps your docs fresh, and is also a good place to explain

Apache OFBiz Documentation Guidelines The Apache OFBiz Project Version Trunk Table of Contents 1. Intro. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reference [3] • Asciidoc Recommended Practices [4] If you would like to help out with the documentation of the project, please see the following wiki page [5] for further information and how we are org/docs/asciidoc-recommended-practices/ [5] https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team 2 2. General rules 2.1. Document configuration Documents that will be published as standalone

Apache OFBiz Documentation Guidelines The Apache OFBiz Project Version Trunk Table of Contents 1. Intro. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reference [3] • Asciidoc Recommended Practices [4] If you would like to help out with the documentation of the project, please see the following wiki page [5] for further information and how we are org/docs/asciidoc-recommended-practices/ [5] https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team 2 2. General rules 2.1. Document configuration Documents that will be published as standalone

[Apache OFBiz Logo] | OFBiz-Logo.svg Apache OFBiz Documentation Guidelines The Apache OFBiz Project Version release22.01 Table of Contents 1. Intro. . . . . . . . . . . . . . . . . . . . . . . . Reference [3] • Asciidoc Recommended Practices [4] If you would like to help out with the documentation of the project, please see the following wiki page [5] for further information and how we are org/docs/asciidoc-recommended-practices/ [5] https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team 2 2. General rules 2.1. Document configuration Documents that will be published as standalone

[Apache OFBiz Logo] | OFBiz-Logo.svg Apache OFBiz Documentation Guidelines The Apache OFBiz Project Version trunk Table of Contents 1. Intro. . . . . . . . . . . . . . . . . . . . . . . . . . . Reference [3] • Asciidoc Recommended Practices [4] If you would like to help out with the documentation of the project, please see the following wiki page [5] for further information and how we are org/docs/asciidoc-recommended-practices/ [5] https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team 2 2. General rules 2.1. Document configuration Documents that will be published as standalone

Apache OFBiz Documentation Guidelines The Apache OFBiz Project Release 18.12 Table of Contents 1. Intro. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . would like to help out with the documentation of the project, please see the following wiki page [5: https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team] for further information :source-highlighter: rouge ⑥ endif::[] ⑦ ① author ② target release, indicates the release for which this documentation is valid ③ global definition of the image directory ④ begin block of configurations only for

form of code and documentation, with communities and projects realizing the importance of documentation and more open source contributors getting involved in writing documentation.  85% 的开发者认为开源活 组织以及媒体宣传 也是很多人在社区会参与的工作。 The vast majority of respondents are involved in writing code or documentation in the community. Testing, localization, event organization, and media outreach are also tasks just code but also non-code work. In addition, open source projects attach great importance to documentation, which is also reflected in this survey. 4.4 接触开源的时间 / 4.4 Time of engaging in open source

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.4. The Apache OFBiz documentation system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . file ├── servicedef - Defined services. ├── src/ ├── docs/ - component documentation source └── main/java/ - java source code └── test/java/ - java unit-tests other form displays search results. 1.4. The Apache OFBiz documentation system 1.4.1. Overview there are two supports for OFbiz documentation, the wiki and some mains documents (in pdf and html format)

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.4. The Apache OFBiz documentation system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . file ├── servicedef - Defined services. ├── src/ ├── docs/ - component documentation source └── main/java/ - java source code └── test/java/ - java unit-tests other form displays search results. 1.4. The Apache OFBiz documentation system 1.4.1. Overview there are two supports for OFbiz documentation, the wiki and some mains documents (in pdf and html format)

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.4. The Apache OFBiz documentation system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . file ├── servicedef - Defined services. ├── src/ ├── docs/ - component documentation source └── main/groovy/ - A collection of scripts written in Groovy └── main/java/ other form displays search results. 1.4. The Apache OFBiz documentation system 1.4.1. Overview there are two supports for OFbiz documentation, the wiki and some mains documents (in pdf and html format)