中文技术文档与产品文案规范 <!-- 作者:Fenng(GitHub:@Fenng) -- 适用范围 将本 Skill 用于中文技术内容的撰写、改写、校对和审阅,包括: - 文档首页、产品介绍、解决方案页和更新日志 - API 文档、参数说明、错误码和常见问题 - 操作手册、故障排查、运维 Runbook 和安全说明 - 界面文案、按钮、导航、状态和提示信息 不要改写代码字面量、JSON 键名、URL、API 路径、数据库字段名、命令、配置项或其他机器可读标识符。 规则优先级 发生冲突时,按以下顺序处理: 1. 保留事实、逻辑、限制、安全信息和法律含义。 2. 服从用户明确要求和目标项目约定。 3. 保持技术术语和机器可读内容准确。 4. 改善结构、语义、语气和可扫读性。 5. 最后处理标点、留白、大小写等排版细节。 不得为了句子更短、语气更确定或格式更统一而牺牲更高优先级的信息。 事实保真 - 不新增原文或可靠上下文没有提供的日期、数字、时限、SLA、能力、条件、因果关系或结论。 - 不删除前置条件、适用范围、例外、风险、安全警告、兼容性说明或失败处理。 - 不把可能、计划、建议、通常等不确定表达改成确定事实。 - 信息不足时保留原意,或明确标记「待确认」;不要自行补全。 - 改写引用、法规、合同、错误原文或用户提供的固定文案时,优先保持原文并将建议单独列出。 示例: - -…