用途:为项目初始化一套规范的基础文件与目录结构,让项目在起步阶段就具备良好的文档、配置与协作基础。
主要能力:提供必备文件清单,包括 README.md(主视觉横幅、概览、快速开始)、CONTRIBUTING.md(贡献方式)、LICENSE.md(法律条款)、CHANGELOG.md(版本历史)、.gitignore(忽略文件)、.editorconfig(统一格式)。给出 README 结构建议:主视觉 SVG 横幅、项目名、一句话描述、功能列表、快速开始(最多 3 条命令)、文档链接、许可证徽章与链接。主视觉横幅建议宽度 800-1200px、高度 200-400px,包含 Logo、标语、3-5 个关键功能,使用 SVG 并提供 PNG 回退,支持深色/浅色模式变体。文档目录建议包含 README.md(索引)、QUICK-START.md(5 分钟指南)、ARCHITECTURE.md(系统设计)、API.md(参考)、CONTRIBUTING.md(开发指南)。规划文件按需使用:ROADMAP.md(多阶段项目)、TODO.md(简单任务跟踪)、DECISIONS.md(架构决策)、RISKS.md(已知风险)。按技术栈提供配置建议:Node.js 用 package.json、tsconfig.json、.nvmrc;Python 用 pyproject.toml、requirements.txt;VS Code 用 .vscode/settings.json、launch.json;GitHub 用 .github/workflows/、CODEOWNERS。质量检查清单:README 有主视觉横幅、快速开始可在 5 分钟内跑通、已指定许可证、存在贡献指南、.gitignore 适配技术栈。
使用方式:资料未提供具体安装命令或调用步骤,仅说明可参考 synapses.json 查看连接关系。
适用场景:新项目初始化、开源仓库搭建、团队协作规范建立。
限制:资料未说明支持的平台、收费方式或自动化程度,具体执行细节暂未提供。