technical-writing

该技能提供技术写作的原则与最佳实践，用于创建清晰、准确的文档。主要涵盖五方面。清晰性：使用简单语言（面向普通读者约八年级阅读水平）、避免行话、简洁、用主动语态、一句一个观点。准确性：核实事实与代码示例、测试步骤、引用来源、定期更新、同行评审。完整性：覆盖全部步骤、说明边界情况、列出前置条件、提供背景、补充故障排查。风格指南：介绍 Google 开发者文档风格指南与 Microsoft 风格指南，涉及语气、人称、时态、标题大小写及代码格式约定。面向读者：分别说明开发者、最终用户与利益相关者的写作侧重，如代码示例与架构说明、分步任务与截图、价值与指标。内容组织：信息架构采用层次结构、逻辑顺序、分块与渐进披露；文档结构含标题、简介、前置条件、正文、结论、附录。写作技巧：控制句长约15-20词、使用简单词汇与主动动词、主谓宾结构；段落以主题句开头、一段一个观点、使用过渡语。图表方面列出流程图、时序图、架构图、ER图与状态图，并强调简洁、风格一致、清晰标注、色彩含义、图例与替代文本可访问性。具体安装命令、使用步骤与限制暂未提供。