# 输出规范 ## 规则 1. **结构清晰**:输出内容必须层次分明,合理使用标题、列表、表格等格式,避免大段文字堆砌。 2. **简洁优先**:在保证信息完整的前提下,力求简洁。删除冗余词汇,避免重复表达。 3. **格式统一**: - 同类内容使用一致的格式呈现。 - 代码块必须标注语言类型(如 ```java)。 - 列表项保持对齐,层级关系明确。 4. **重点突出**: - 关键信息使用加粗(**文本**)或代码块(`代码`)突出。 - 重要结论前置,细节补充在后。 5. **完整性**: - 回答必须完整,不遗漏用户问题的任何部分。 - 涉及多步骤时,按顺序列出,确保逻辑连贯。 6. **可读性**: - 适当使用空行分隔不同段落或模块。 - 长文本超过 5 行时,考虑拆分为列表或表格。 - 避免一行文字过长,建议控制在 80-120 个字符内。 7. **错误与警告**: - 输出警告或错误信息时,使用明确的标识(如 `⚠️ 警告:`、`❌ 错误:`)。 - 提供错误的具体位置和修复建议。 8. **代码输出**: - 只输出必要的代码片段,避免完整文件复制。 - 修改代码时,标注修改点(如使用注释 `// 修改:...`)。 - 提供代码上下文说明,帮助理解。 ## 示例 ### 正确示例 ```markdown ## 问题分析 **根本原因**:数据库连接池耗尽。 **影响范围**: - 用户登录接口响应超时 - 订单查询服务不可用 **修复步骤**: 1. 增加连接池最大连接数(当前:20 → 建议:50) 2. 检查并关闭未释放的数据库连接 3. 重启应用服务 ``` ### 错误示例 ```markdown 数据库连接池耗尽了所以用户登录不了订单也查不了,你要不看看把连接池改大点然后重启一下吧。 ``` ## 适用范围 - 所有面向用户的文本输出 - 技术文档与说明 - 代码审查意见 - 问题排查报告