From ecb4ba15dd9afc564cea4f916764b3727fcc16ca Mon Sep 17 00:00:00 2001 From: pengqun Date: Wed, 28 Feb 2024 21:10:35 +0800 Subject: [PATCH] Improve introduction texts --- README.md | 4 ++-- README_zh.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 190a2c2..8e44bd4 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/README_zh.md b/README_zh.md index 3c366d5..5580704 100644 --- a/README_zh.md +++ b/README_zh.md @@ -11,6 +11,8 @@ TODO: 本列表期望能为改善文档效率和质量提供一些帮助，包括提供开箱即用的模板、实用的文档工具、有洞察的文档指南、有广泛共识的文档标准，以及一些真实的文档案例。 +其他语言版本: [🇬🇧🇳 英语](README.md) + ## 内容 - [文档类型](#文档类型)