technical-readme-structure
技术项目 README 结构
这个 skill-unit 处理的是“技术仓库入口文档”问题。它只适用于技术项目 README,不适用于公司介绍、产品宣传页、个人主页或通用文案型简介。
核心原则
1. 技术边界 —— 它是技术入口,不是通用介绍页
- README 的目标是让技术读者快速理解项目是什么、怎么启动、系统如何组织。
- 这个 skill 默认面向代码仓库、工程项目、框架、工具、服务或平台型仓库。
- 如果目标文档主要是品牌介绍、市场表达、业务方案或对外宣传,这个 skill 就不应主导。
2. 入口优先 —— 先解决首次上手问题
- README 首先要回答:项目是什么、怎么启动、最小验证是什么。
- 关键信息应尽量留在 README 中,不把首次上手必须知道的内容散落到多个外部文档。
- 对首次读者最关键的是最短闭环,而不是信息面面俱到。
3. 结构稳定 —— 必要模块不能缺位
More from qiao-925/qiao-skills
agent-skill-rules
Agent Skills 开放标准与治理规则。用于 skill 的创建、修改、重构、迁移、审计与维护,并在创建前判断需求应落到自动化、项目级规则、通用或项目私有 skill 还是单次 prompt,提供平台无关的结构标准、frontmatter 规范、渐进式披露与质量门禁。
35python-coding-standards
Python 实现基线能力单元,帮助 Agent 在 Python 代码实现、修改、补全、重构与审查场景中,先对齐项目既有约定,再落实类型边界、日志纪律、命名与结构可读性,避免把个人偏好或项目私货写成通用规范。关键词:Python、编码规范、类型提示、日志、命名、代码结构、项目对齐。
23critical-thinking-guidance
规范 Agent 在解答前进行智能判断与思考引导,避免不必要的替代思考并保留用户主导权。适用于用户提问、方案咨询、学习交流等需要平衡效率与思考深度的场景。关键词:引导提问、智能判断、轻量引导、强制思考
21single-responsibility
单一职责能力单元,帮助 Agent 在文件拆分、函数重构、模块设计、代码审查与边界澄清场景中,识别职责混杂、变化原因耦合与命名失真问题,让文件、函数、类与模块都能围绕一个稳定职责组织。关键词:单一职责、职责拆分、边界澄清、重构、文件拆分、函数重构、模块设计。
20architecture-governance
架构治理能力单元,帮助 Agent 在架构评审、重构、新模块设计、分层边界调整、接口契约设计与项目初始化分析场景中,检查分层与依赖方向、变更影响面、接口契约与可替换性,避免跨层耦合、反向依赖与破坏性演进。关键词:架构治理、分层、依赖方向、影响面分析、接口契约、依赖注入、可插拔、重构。
19core-first-simplicity
核心优先的复杂度控制能力单元,帮助 Agent 在项目取舍、架构设计、模块重构、实现裁剪与方案收敛场景中,先识别主亮点、控制复杂度预算、稳定主路径、延后非核心扩张,避免过度设计与大而全实现。关键词:核心优先、复杂度控制、KISS、方案收敛、过度设计、主路径。
19