hf400159 opened a new issue #6651: URL: https://github.com/apache/apisix/issues/6651
### Current State Because the articles of Apache APISIX are contributed by different people, the current format of document is not uniform, the style of writing is not uniform, the terms are not unified, and the structure is not unified. 中文描述：由于 Apache APISIX 的文章是由不同的人贡献的，因此当前文档存格式不统一、写作风格不统一、用词不统一、架构不统一等问题。 ### Desired State I want to develop a Apache APISIX Chinese document writing standard for the reference and moderator of document contributors. At the end of March, I will show the first draft. If you have more ideas, please let me know. It mainly includes document writing specification and document writing template. 1. Document writing specification: including the correct writing method of common words, code format, name examples, usage rules of mark pairs, glossary, etc. 2. Document writing template: including principle documents, operation documents, etc. The following is the completed part, please check: Personal pronouns, IP addresses and domain names, punctuation, operators, sentences, tables, pictures, word spacing, lists, notes, links, marker pairs, code segments, links, prohibited words, terms, etc. 中文描述： 因此，我想制定一份 Apache APISIX 中文文档写作标准，以供文档贡献者参考和审核者审查。3月底，我会展示初稿。如果你有更多的想法，请告诉我。 规范内容主要包括文档写作规范和文档写作模板。 1. 文档写作规范：包括常用词的正确写法，代码格式，名称示例，标记对使用规则，术语表等内容。 2. 文档写作模板：包括原理类文档， 操作类文档等内容。 以下是已完成部分，请查看： 人称代词、 IP 地址和域名、标点符号、运算符、句子、表格、图片、字间距、列表、Note、链接、标记对、代码段、链接、违禁词、术语等。 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
