technical-readme-structure

Installation
SKILL.md

技术项目 README 结构

这个 skill-unit 处理的是“技术仓库入口文档”问题。它只适用于技术项目 README,不适用于公司介绍、产品宣传页、个人主页或通用文案型简介。

核心原则

1. 技术边界 —— 它是技术入口,不是通用介绍页

  • README 的目标是让技术读者快速理解项目是什么、怎么启动、系统如何组织。
  • 这个 skill 默认面向代码仓库、工程项目、框架、工具、服务或平台型仓库。
  • 如果目标文档主要是品牌介绍、市场表达、业务方案或对外宣传,这个 skill 就不应主导。

2. 入口优先 —— 先解决首次上手问题

  • README 首先要回答:项目是什么、怎么启动、最小验证是什么。
  • 关键信息应尽量留在 README 中,不把首次上手必须知道的内容散落到多个外部文档。
  • 对首次读者最关键的是最短闭环,而不是信息面面俱到。

3. 结构稳定 —— 必要模块不能缺位

Related skills

More from qiao-925/qiao-skills

Installs
6
First Seen
Mar 14, 2026