New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc 对于开源软件的价值 #471

Open

strint opened this issue Apr 18, 2022 · 0 comments

Contributor

strint commented Apr 18, 2022 •

edited

Loading

Doc解决的是沟通问题，提高了开发者自服务的能力，使得开发者大部分情况下可以不找另外一个开发者就能独立完成工作。

信息沟通的形式

没有文本化的沟通，就是不存在的沟通
- 开源世界需要异步、可回溯的沟通
README
- 介绍服务的核心领域
- 介绍解决核心问题的功能方案
QuickStart
- 上手要真的可以做到Quick
- 快速安装
- 快速运行
- 编译
文档体系
- API 文档
- 教程
- Change Log，提示用户升级新版本可以获得的新功能、解决的问题、需要做的兼容性修改
问答和求助
- 提供反馈途径，GitHub Issue、论坛、邮件列表【没有文本公开文本记录的讨论就是不存在的讨论】
- 积累问答知识，比如issue
- 在错误提示中就提供解决办法
- 吸引志愿者、布道者、开发者，让外部开发者可以互相帮助，社区自服务

注：周末听Apache基金会的姜宁老师分享后的总结。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment