project-standard.md

项目标准

这份文档定义 GitHub 新手村的内容标准、仓库标准和运营标准。目标是让项目长期保持清晰、友好、可收藏、可贡献。

项目定位标准

本项目只解决一个核心问题：

帮助 GitHub 新手真正入门 GitHub。

内容应始终服务于这个目标。不要把项目扩展成复杂 Git 内部原理、DevOps 平台教程或高级 Git 技巧集合。

内容标准

每篇正式教程尽量包含：

• 学习目标
• 适合人群
• 核心概念解释
• 生活化比喻
• 实际操作步骤
• 示例内容
• 小练习
• 常见错误提醒
• 延伸阅读

新手友好标准

写作时默认读者：

• 第一次打开 GitHub
• 不熟悉英文技术词
• 不知道命令行是什么
• 害怕把项目弄坏
• 不理解开源协作流程

因此文档应遵守：

• 先解释为什么，再给步骤。
• 每次只引入少量新术语。
• 命令前说明运行位置。
• 报错时解释原因，而不是只给命令。
• 不使用嘲笑式表达，例如“很简单”“显然”“基础问题”。

README 标准

README 必须回答：

• 这个项目是什么？
• 解决什么痛点？
• 适合谁？
• 第一次来应该点哪里？
• 有哪些已完成内容？
• 有哪些可收藏资源？
• 如何贡献？

README 首屏应尽量让用户在 10 秒内判断是否值得收藏。

练习标准

每个练习项目必须包含：

• 目标
• 操作步骤
• 文件结构
• 示例 Markdown 或代码
• 提交要求
• 完成标准

练习应尽量控制在 10 到 30 分钟内完成。

贡献标准

适合新手的贡献任务应具备：

• 范围小
• 文件位置明确
• 完成标准明确
• 不需要复杂本地环境
• 最好只改 Markdown

PR 审核时优先关注：

• 是否更容易理解
• 是否对新手有帮助
• 是否和项目定位一致
• 是否保持文档结构清晰

收藏价值标准

项目要持续提供可反复使用的资源：

• 路线图
• 术语表
• 速查表
• 模板
• 练习项目
• 报错排查
• FAQ

只适合读一次的内容，不如能反复查阅的内容更有收藏价值。

发布标准

每次重要更新建议同步更新：

• CHANGELOG.md
• README.md 相关入口
• docs/README.md 或教程目录
• 相关 FAQ

更新说明应写清楚用户能获得什么，而不只是列文件名。