参与共创
WorkBuddy 的能力、界面和使用方式会持续变化。这本蓝皮书希望由真实使用者共同维护:不仅纠正事实,也不断补充可复现的任务、失败经验和团队方法。
可以贡献什么
- 修正错别字、失效链接、过时界面和不准确表述。
- 补充一个真实、可复现的 WorkBuddy 案例。
- 为现有案例增加输入、输出、验收标准和失败处理。
- 补充岗位或行业工作流。
- 改进截图、图表、导航和无障碍体验。
最轻量的方式:提交 Issue
如果暂时不想修改文件,可以在 GitHub Issues 中说明:
- 哪一页需要调整。
- 现在的问题是什么。
- 建议怎样修改。
- 如果涉及产品事实,请附上来源或截图。
直接修改内容
- Fork 或克隆仓库。
- 找到
docs/bluebook/下对应章节的index.md。 - 修改内容或在同目录的
assets/中补充素材。 - 本地运行
npm install和npm run docs:build。 - 提交 Pull Request,并说明改动、原因和验证方式。
完整规范见仓库根目录的 CONTRIBUTING.md。
内容原则
- 真实任务优先:说明输入、步骤、交付物和验收方式。
- 事实与经验分开:产品事实尽量附来源;个人经验说明适用条件。
- 对新手友好:不要假设读者知道工具、权限和术语。
- 安全边界清晰:涉及文件、账号、密钥、发布和外部操作时说明风险。
- 尊重隐私与版权:不要提交密钥、个人数据或无权公开的资料。