To help developers efficiently use each release, OpenHarmony provides related documents (such as the guide, API reference, development examples, release notes, API changelog, and FAQs) based on the feature requirements planned for the release. Some requirements involve new features and documents, and others require updates to the existing features and documents.
When planning a feature requirement, each service Special Interest Group (SIG) should determine whether the requirement involves new documents or updates to existing documents. If new documents or updates are involved, they should break down the requirement to the Docs SIG for document requirement tracking. The Docs SIG will provide document design suggestions based on the requirement and cooperate with the service SIG in document review, translation, and release. The document development process is shown below.
Members in each service SIG write basic documents for the release. Developers in the community are welcome to participate in the development of feature documents.
Provide the Documents breakdown in the service SIG requirement issue. If new documents or updates to the existing documents are required, this requirement issue must be liked to the Docs SIG.
View the feature requirements of the release in OpenHarmony Roadmap. This roadmap provides the release time plan, features to deliver, feature status, and SIG information.
If a feature requirement involves document delivery, add Yes in the Need Docs column so that the Docs SIG can track the document delivery.
If you are a member of a service SIG and are responsible for developing a new feature, you should cooperate with the Docs SIG to ensure that feature documents are available before the release. Any feature that is not provided with related documents may be removed from the release.
If you need help in the document structure, ask questions in the #SIG-Docs
Zulip.
To ensure the accuracy of technical description, ask technical experts in the service SIGs to review all new contents. In addition, ask documentation experts in the Docs SIG to review the standardization of the documents. For details, see Document Reviewers. To assign experts for review, enter the at sign (@) followed by the experts' usernames in the PR comment area. You can also provide review requirements in the #SIG-Docs
Zulip.
You should update the draft against all the review comments. The PR can be merged only after both of the following conditions are met:
TechApprove
.DocsApprove
.Submit your documents for version testing. Testers in the test SIG will submit issues to the Docs repository for any document issues they find. Confirm their comments and update the documents accordingly.
The OpenHarmony community provides Chinese and English documents. After the Chinese documents are reviewed, tested, and finalized, they can be submitted for translation in the form of issues. Translators in the Docs SIG will complete the English documents.
Translators submit English documents through PRs and provide the link to the corresponding issue in the PR description. To ensure the accuracy of every English document, the translator should ask technical experts in the service SIG for technical review, by entering the at sign (@) followed by the experts' usernames in the PR comment area. The technical experts can be the author of the Chinese document or others. For details, see Document Reviewers.
The translator should update the English document against all the review comments. The PR can be merged only after the following conditions are met:
TechApprove
.DocsApprove
.To provide a translation requirement for a document in a non-Docs repository (such as translation for API comments), submit a translation requirement issue in the Docs repository. Translators in the Docs SIG will complete the English document.
When submitting a translation requirement, ensure that:
Members in the Docs SIG or document contributors should cooperate with each service SIG in reviewing and optimizing documents and translating Chinese documents into English. They should ensure that the output meets the release requirements.
To know feature and release plans of a release, you can attend the meeting SIG Release held on Friday every two weeks. Understand the release progress, requirement delivery progress, and document delivery progress.
You can also view feature requirements of a release in OpenHarmony Roadmap. You can select feature issues marked with SIG_Docs and associated document PRs.
When reviewing a feature document, you are advised to provide review suggestions from the following aspects:
If a PR involves the addition of a Markdown page, ensure that:
When a Markdown page is deleted or a Markdown page name is changed, ensure that:
For more detailed specifications, see Writing Instructions.
Translation requirement issues in the community will be translated by translators in the Docs SIG. Document contributors are also welcome to take up translation requirement tasks and submit English documents through PRs.
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》