Skip to content

Commit ecb4ba1

Browse files
committed
Improve introduction texts
1 parent 2b56207 commit ecb4ba1

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ TODO:
99

1010
> A curated and **up-to-date** list of resources on software documentation templates, tools, guides & examples.
1111
12-
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.
12+
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.
1313

14-
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.
14+
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.
1515

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

README_zh.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ TODO:
1111

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

14+
其他语言版本: [🇬🇧🇳 英语](README.md)
15+
1416
## 内容
1517

1618
- [文档类型](#文档类型)

0 commit comments

Comments
 (0)