图 1.1 三种内容共用相同的文档骨架
三张文档保留相同的标题与正文形状，从左到右看各自的内容模块
- 左侧蓝色模块表达图文展示
- 中间绿色模块表达能力组合
- 右侧紫色模块表达内容列表
这是一张结构示意图，帮助理解共用骨架怎样保留项目差异，无法从图中确认任何软件功能或检查结果
技能（Skill）是一组供编码助手重复使用的指令与配套文件
编码助手读取入口后，会按当前任务选择规则和模板，再形成具体修改
维护者反复编写项目首页时可以使用本技能；技能本身不会自动运行，也不授予发布权限
本技能适合需要统一项目首页、保留各项目特点的维护者
- 审计已有首页，定位失效入口与事实缺口
- 编写中文首页
- 按同一事实同步英文说明
- 根据主要交付物选择上手路径
- 选择或制作能帮助理解的头图
- 检查本地文件及页面在不同显示条件下的可用性
中文表达使用当前安装的 human-readable-technical-writing 及其完整规则
本仓库维护项目结构和视觉选择，不另存一份会逐渐过期的中文写作规范
- 需要使用能够读取本地技能的编码助手
- 当前环境应已安装
human-readable-technical-writing
首次使用前确认助手可以找到本仓库的 SKILL.md
-
第一步，把本仓库作为本地技能提供给助手，入口为 技能说明
-
第二步，在任务中写明目标仓库及本次处理方式，处理方式选择只读审计或修改首页
-
第三步，使用下面的请求示例，让助手根据项目实际内容工作
请使用 $github-readme-standardizer 审计当前仓库 完整应用已安装的 $human-readable-technical-writing 最新规则 只报告首页结构、上手步骤和头图的问题，并给出对应文件证据
上面是给助手的请求文本，不是终端命令 正常结果是带有文件依据的问题说明，当前示例没有要求修改或发布
需要改进时，将请求中的“只报告”替换为以下两项要求
- 修复已确认的问题
- 同步中英文首页
需要发布时，另行提供发布要求
- 目标仓库
- 允许的操作
- 使用
github-safe-publish处理发布
首页共同回答用途、第一次操作、进一步使用、状态限制和求助许可
-
短工具可以合并示例与上手步骤
-
课程可以把安装位置替换为阅读入口
-
中文模板 提供精简骨架，不预设安装工具
-
英文模板 保持相同信息位置
-
组合方案 说明哪些内容随项目变化，并给出课程仓库的完整使用示范
-
项目分类 根据主要交付物选择内容顺序
-
可选模块 按已有证据增加界面、测量结果或组件关系
-
中文规则衔接 说明怎样在正文落实术语定义与局部复核
-
模板中的占位值必须替换
-
缺少依据的可选内容应删除
-
已有许可证、引用和第三方署名按原文保留
制作前先确定图片要帮助读者判断的具体问题，以下条件用于选择对应方式
- 有代表性真实界面时使用脱敏截图
- 主要价值是命令结果时展示真实合成输入的输出
- 需要解释内容或组件关系时制作可编辑结构图
- 需要表达品牌形象时可以使用明确标为品牌插画的生成图
- 图片不能增加理解时可以省略头图
本仓库头图使用无文字结构示意，避免小屏文字缩得过小，也方便两种语言共用
Python 编程语言（Python）用于编写和执行程序，本仓库用它运行文档检查
解释器读取检查脚本后输出问题记录，审计程序不会修改原始文件
本地检查用于发现已经实现的确定问题，人工仍需核对事实并查看实际图片
本地检查需要能够运行当前脚本的 Python 环境，命令在本仓库根目录运行
python -X utf8 scripts/audit_readme.py . # 检查本仓库的中英文首页及关联文件-
返回
PASS表示本次机械检查没有发现硬错误- 阅读提醒并判断其是否适用于当前内容
- 按实际文件核对正文事实
-
返回
FAIL时按以下步骤处理-
第一步，查看
errors中的问题位置 -
第二步，修复对应内容
-
第三步，重新运行检查
-
-
中文写作还需执行已安装写作技能规定的复核，检查器不能证明解释完整
-
页面预览需覆盖亮色、暗色、桌面和窄屏，具体方法见 验证说明
不在首页写入容易过期的测试数量，当前自动检查可在 检查记录 核对
- 自动检查只能识别已经实现的规则，不能确认所有事实、图片使用权或读者是否理解
- 图片生成不能替代真实界面或测量结果
- 发布必须遵守目标仓库保护规则及用户授权
- 当前仓库没有附带许可证文件，不能把公开可见理解为已经获得复制、修改或再分发许可