QLHazyCoder
4.3 KiB
4.3 KiB
公告书写标准
本文件用于约束 AI 生成“账号贡献站 / Codex 注册扩展”相关公告时的 Markdown 格式。
使用方式：
- 先把这份文件内容发给 AI
- 再补充你这次要发的实际事项
- 让 AI 严格按本文格式输出完整 Markdown
- 最后把结果直接复制到管理端公告编辑框中
1. 公告用途
公告用于发布以下信息：
- 站点新增功能
- 上传规则变更
- 页面调整
- 暂停维护通知
- 已知问题说明
- 临时提醒
- 外部引导信息
公告不是教程，不需要展开写成长文。
2. 公告总体要求
AI 生成公告时必须满足：
- 使用标准 Markdown
- 不使用 HTML 标签
- 不写成口语化碎碎念
- 标题明确，首段直接说明本次公告主题
- 优先写结论，再写细节
- 语气清晰、正式、简洁
- 尽量让用户在 10 秒内看懂重点
3. 标准结构
公告建议按以下结构输出：
# 公告标题
一句话概述本次公告核心内容。
## 本次调整
- 要点 1
- 要点 2
- 要点 3
## 影响范围
- 影响项 1
- 影响项 2
## 用户需要做什么
- 用户动作 1
- 用户动作 2
## 补充说明
补充说明内容。
不是每次都必须写满所有章节，但至少要保证：
- 有一级标题
- 有概述
- 有要点列表
4. 标题规范
标题必须满足：
- 直接说明主题
- 不使用夸张标题党
- 不写“通知一下”“说一下”这种模糊表述
推荐标题示例：
# 账号贡献页新增公告与使用教程入口# 上传规则调整说明# sub2api 文件校验规则更新# 站点临时维护公告
不推荐：
# 说个事# 看一下# 更新了
5. 正文写法规范
5.1 第一段
第一段必须直接说清：
- 发生了什么
- 对谁有影响
- 是否需要操作
示例：
账号贡献页现已新增公告与使用教程区域，后续站点通知会优先通过公告发布，使用说明会统一整理到教程中。
5.2 列表
重要事项优先使用短列表：
## 本次调整
- 首页右侧新增公告区域
- 排行榜与使用教程支持切换查看
- 教程内容仅在后台开启且有内容时显示
5.3 代码或路径
涉及文件名、路径、接口、命令时必须用反引号包裹：
codex-*.jsonsub2api-account-*.jsonPOST /api/upload账号贡献/contrib-portal
6. 禁止项
AI 生成公告时禁止：
- 使用 HTML
- 写超长大段无分段文字
- 同一句里堆太多信息
- 写模糊时间词但不写清上下文
- 写成教程
- 写成 PR 描述
- 写内部开发者视角内容
不要写：
- “这个地方我改了一下”
- “目前来说应该差不多”
- “可能有点问题后面再看”
7. 推荐语气
推荐风格：
- 冷静
- 直接
- 不啰嗦
- 对用户友好
推荐表达：
- “现已支持”
- “已调整为”
- “后续将通过此处发布”
- “如你正在使用旧流程，请注意以下变化”
8. AI 生成公告时的固定指令
把下面这段直接发给 AI：
请帮我写一份“账号贡献站 / Codex 注册扩展”公告，严格遵守以下要求：
1. 输出必须是 Markdown
2. 不要使用 HTML
3. 风格简洁、正式、清楚
4. 先写结论，再写细节
5. 重要信息尽量用短列表
6. 涉及文件名、路径、接口、命令时用反引号包裹
7. 不要写成长教程
8. 不要写内部开发过程，只写用户看得懂的公告
请按以下结构输出：
# 标题
一句话概述
## 本次调整
- ...
## 影响范围
- ...
## 用户需要做什么
- ...
## 补充说明
...
9. 可直接替换变量模板
你每次可以这样发给 AI：
请按“账号贡献站公告标准”帮我写一份 Markdown 公告。
本次公告主题：
[这里写主题]
这次变更点：
- [变更点 1]
- [变更点 2]
- [变更点 3]
希望重点强调：
- [强调点 1]
- [强调点 2]
用户是否需要额外操作：
[是 / 否]
如果需要，操作内容：
- [操作 1]
- [操作 2]
10. 结果验收标准
生成后的 Markdown 必须满足：
- 复制到管理端后能直接显示
- 结构清楚
- 第一眼能看懂重点
- 没有 HTML
- 没有明显 AI 套话
- 没有多余开发术语