🚀 Innovation Playbook
🎯 新手入门🎯 Get Started 🛠️ 创建项目🛠️ Create Project 📋 模板指南📋 Template Guide 🔄 生命周期🔄 Lifecycle ❓ FAQ 📜 治理📜 Governance
中文 EN

📋 模板参考手册

📋 Template Reference Manual

了解创新项目模板包含什么、每个部分的作用,以及如何根据你的需求自定义扩展。

Learn what the innovation project template contains, the purpose of each section, and how to customize and extend it to fit your needs.

🎯 适合:想深入了解模板结构的人🎯 For: Anyone wanting to understand the template structure ⏱️ 阅读时间:5 分钟⏱️ Reading time: 5 min
🤔 什么是创新项目模板?
🤔 What is the Innovation Project Template?

模板(Template Repository)是一个已经准备好的项目骨架,帮助你跳过繁琐的初始化工作,直接进入核心内容。

The Template Repository is a pre-built project skeleton that helps you skip tedious initialization work and jump straight into the core content.

📁
标准结构
Standard Structure
推荐的目录和文件
Recommended directories and files
📝
README 模板
README Template
引导你思考问题
Guides you to think through problems
📌
最佳实践
Best Practices
内置说明和示例
Built-in instructions and examples
🚀
即开即用
Ready to Use
一键创建,不需配置
One-click creation, no setup needed
💡 想直接创建项目?请前往 创建项目教程,那里有完整的操作步骤。本页面重点介绍模板的结构和自定义方法。
💡 Want to create a project right away? Head to the Create Project Tutorial for step-by-step instructions. This page focuses on the template's structure and customization methods.
📂 模板包含哪些文件?
📂 What Files Does the Template Include?

使用 template-innovation-repo 创建的项目默认包含以下结构:

Projects created using template-innovation-repo include the following structure by default:

📝

README.md — 项目说明书

README.md — Project Description

这是你的项目最重要的文件。模板已预设了 ProblemIdeaStatus 等字段,帮助你结构化地描述项目。

This is the most important file in your project. The template comes with pre-set fields like Problem, Idea, and Status to help you describe your project in a structured way.

⭐ 任何人访问你的 Repo,第一眼看到的就是这个文件。

⭐ This is the first thing anyone sees when they visit your Repo.

📄

.gitignore — 忽略规则

.gitignore — Ignore Rules

告诉 Git 哪些文件不需要被跟踪(如临时文件、编译产物、环境变量等)。通常不需要修改。

Tells Git which files should not be tracked (such as temp files, build artifacts, environment variables, etc.). Usually no modifications needed.

📜

LICENSE — 开源协议

LICENSE — Open Source License

定义其他人可以如何使用你的代码。模板默认使用 MIT 协议(最宽松的开源协议)。

Defines how others can use your code. The template uses the MIT License by default (the most permissive open source license).

📝 README 各字段详解
📝 README Field Details

模板 README 中有几个预设字段,这是它们的含义和填写建议:

The template README has several pre-set fields. Here are their meanings and tips for filling them in:

P

Problem(问题)

Problem

写什么:你想解决什么问题?谁遇到了这个问题?影响有多大?

What to write: What problem are you solving? Who encounters this problem? How significant is the impact?

怎么写:2-3 句话即可。用具体的场景描述,而不是抽象的目标。

How to write: 2-3 sentences is enough. Use concrete scenarios, not abstract goals.

✅ "团队每周花 2 小时整理会议纪要,经常遗漏 Action Items"

✅ "The team spends 2 hours weekly organizing meeting notes and often misses Action Items"

❌ "提升团队效率"(太抽象)

❌ "Improve team efficiency" (too abstract)

I

Idea(想法)

Idea

写什么:你打算怎么解决?用什么技术或方法?

What to write: How do you plan to solve it? What technology or approach will you use?

怎么写:初步思路即可,不需要完整方案。

How to write: A rough idea is fine — you don't need a complete solution.

✅ "用 Whisper API 做语音转文字,再用 GPT 自动摘要"

✅ "Use Whisper API for speech-to-text, then GPT for auto-summarization"

❌ "用 AI 解决"(太模糊)

❌ "Use AI to solve it" (too vague)

S

Status(状态)

Status

标记项目当前所处的生命周期阶段:

Mark the current lifecycle stage of your project:

  • idea — 刚有想法,还没开始动手
  • prototype — 正在做 Demo 或 PoC
  • active — 已有用户在使用
  • idea — Just an idea, haven't started yet
  • prototype — Building a Demo or PoC
  • active — Already has users

随项目发展及时更新状态。详见 项目生命周期

Update the status as your project evolves. See Project Lifecycle for details.

🔧 如何扩展模板结构?
🔧 How to Extend the Template Structure?

当你的项目逐渐成长,可以按需添加以下目录和文件:

As your project grows, you can add the following directories and files as needed:

📝
notes.md
记录灵感和想法
Record ideas and inspirations
🧪
demo/
Demo 代码或截图
Demo code or screenshots
📖
docs/
设计文档和架构
Design docs and architecture
🧩
src/
源代码
Source code
🧪
tests/
测试代码
Test code
📊
data/
示例数据或分析
Sample data or analysis
💡 新手建议:先把 README 写清楚,再考虑加其他文件。不要一开始就追求完美的项目结构。
💡 Beginner tip: Write a clear README first, then consider adding other files. Don't aim for a perfect project structure from the start.
⚡ 做与不做
⚡ Do's and Don'ts

✅ 推荐

✅ Recommended

  • 先写 README 再写代码Write the README before writing code
  • 保留模板原有文件结构Keep the template's original file structure
  • 尽早 Commit,不等完美Commit early, don't wait for perfection
  • 邀请同事协作和反馈Invite colleagues to collaborate and give feedback

❌ 避免

❌ Avoid

  • 跳过 README 直接写代码Skip the README and jump into code
  • 随意删除模板预设文件Casually delete template preset files
  • 担心"不够成熟"不敢提交Fear submitting because it's "not polished enough"
  • 把模板当成最终成品Treat the template as the final product
🏠 返回首页🏠 Home 🎯 新手入门🎯 Get Started ← 创建项目← Create Project 🔄 项目生命周期 →🔄 Lifecycle → ❓ FAQ 📜 治理与规则📜 Governance & Rules