Skip to content

Commit

Permalink
Improve introduction texts
Browse files Browse the repository at this point in the history
  • Loading branch information
pengqun committed Feb 28, 2024
1 parent 2b56207 commit ecb4ba1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ TODO:

> A curated and **up-to-date** list of resources on software documentation templates, tools, guides & examples.
Software documentation is crucial for ensuring clarity and efficiency throughout the development process, by facilitating better understanding and collaboration among team members. However, for various reasons, the creation and maintenance of documentation has frequently been mishandled, resulting in lots of inefficiency, inconsistency, and poor quality.
Software documentation is critical to ensuring clarity and efficiency throughout the development process by facilitating better understanding and collaboration among team members. However, for a variety of reasons, the creation and maintenance of documentation has often been mismanaged, resulting in inefficiency, inconsistency, and poor quality.

This list aims to assist by providing you with out-of-box templates and practical tools to maximize efficiency, insightful guides and established standards to ensure consistency, and real-world documents to serve as examples.
This list aims to help by providing you with out-of-the-box templates and practical tools to maximize efficiency, insightful guides and established standards to ensure consistency, and real-world documents to serve as examples.

Translations available in: [🇨🇳 中文](README_zh.md)

Expand Down
2 changes: 2 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ TODO:

本列表期望能为改善文档效率和质量提供一些帮助,包括提供开箱即用的模板、实用的文档工具、有洞察的文档指南、有广泛共识的文档标准,以及一些真实的文档案例。

其他语言版本: [🇬🇧🇳 英语](README.md)

## 内容

- [文档类型](#文档类型)
Expand Down

0 comments on commit ecb4ba1

Please sign in to comment.