简洁清晰#
技术文档写作应遵循以下原则：
删繁就简 - 初稿完成后通读全文，删除冗余字词句
逻辑缜密 - 保持内容前后连贯，避免跳跃式表达
避免重复 - 同一文档中相同概念不作复述
具体要求#
使用主动语态明确行为主体 √ 正确："系统自动验证字段格式"
× 不当："字段格式会被自动验证"主谓宾结构完整清晰 √ 正确："开发者需在配置文件中设置超时阈值"
× 不当："设置超时阈值是必要的"单句长度控制在25字以内
同一技术术语全文保持统一
禁止项#
冗长的背景铺垫
多重否定句式
口语化程度副词（非常、极其等）