重要前提
安装AI Skills的关键前提是:必须科学上网,且开启TUN模式,这一点至关重要,直接决定安装能否顺利完成,在此郑重提醒三遍:科学上网,科学上网,科学上网。查看完整安装教程 →
project-documentation by jiffies/project-documentation-skill
npx skills add https://github.com/jiffies/project-documentation-skill --skill project-documentation为软件项目创建清晰、完整且用户友好的 README 和系统文档。
此技能帮助您创建高质量的项目文档,包含:
在编写文档之前,收集基本信息:
信息来源:README、package.json、.env.example、主要代码文件(main.ts、app.ts、routes/)
根据项目需求选择合适的图表:
完整模板和模式:参见 references/mermaid-patterns.md
按此顺序组织使用步骤:
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
每个步骤应包含:目的、命令、预期输出、提示和警告。
完整写作指南:参见 references/step-by-step-guide.md
使用清晰的分隔符构建 .env.example 文件:
# ========================================
# 主类别标题
# ========================================
CONFIG_ITEM=example_value
# ----------------------------------------
# 子类别标题
# ----------------------------------------
CONFIG_ITEM=example_value
记录每个配置项,包含:
完整组织指南:参见 references/config-organization.md
# 项目名称 - 简要描述
## 功能特性
## 系统运行原理(Mermaid 图表)
## 快速开始(分步指南)
## 常用命令
## API 示例
## 技术栈
## 项目结构
## 文档
## 重要说明
## 许可证
在最终确定文档之前,请检查:
流程图:
使用步骤:
配置:
用户友好性:
新项目:理解结构 → 创建图表 → 编写步骤 → 组织配置 → 验证质量
更新现有项目:阅读当前 README → 识别差距 → 添加/优化内容 → 验证质量
优化配置:按功能分组 → 添加分隔符 → 标记必需/可选 → 链接获取方法
每周安装数
67
代码仓库
首次出现
2026年1月30日
安全审计
安装于
github-copilot66
opencode66
gemini-cli64
codex64
cursor64
kimi-cli63
Create clear, complete, and user-friendly README and system documentation for software projects.
This skill helps you create high-quality project documentation with:
Before writing documentation, gather essential information:
Information sources : README, package.json, .env.example, main code files (main.ts, app.ts, routes/)
Choose appropriate diagrams based on project needs:
Complete templates and patterns : See references/mermaid-patterns.md
Organize usage steps in this sequence:
Each step should include : Purpose, commands, expected output, tips, and warnings.
Complete writing guide : See references/step-by-step-guide.md
Structure .env.example with clear separators:
# ========================================
# Main Category Title
# ========================================
CONFIG_ITEM=example_value
# ----------------------------------------
# Subcategory Title
# ----------------------------------------
CONFIG_ITEM=example_value
Document each configuration item with:
Complete organization guide : See references/config-organization.md
# Project Name - Brief Description
## Features
## System Operation Principles (Mermaid diagrams)
## Quick Start (Step by Step)
## Common Commands
## API Examples
## Tech Stack
## Project Structure
## Documentation
## Important Notes
## License
Before finalizing documentation:
Flowcharts :
Usage Steps :
Configuration :
User-Friendliness :
New Project : Understand structure → Create diagrams → Write steps → Organize config → Verify quality
Update Existing : Read current README → Identify gaps → Add/optimize content → Verify quality
Optimize Config : Group by function → Add separators → Mark required/optional → Link acquisition methods
Weekly Installs
67
Repository
First Seen
Jan 30, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
github-copilot66
opencode66
gemini-cli64
codex64
cursor64
kimi-cli63
React 组合模式指南:Vercel 组件架构最佳实践,提升代码可维护性
122,000 周安装