JavaShuo
栏目
标签
README文档的规范写法
时间 2020-12-30
标签
readme
繁體版
原文
原文链接
看过很多开源库,发现有些库的文档写的一团糟,有的甚至就是一个标题,让你自己下载之后运行,自己摸索,看的很头疼。而那些使用量大的库的文档写的很标准,很详细,看的很舒服。 README文档写的好的话能减少很多使用成本,能帮助这个库让更多人了解,更多的人用,可以说好的文档就是一个门面。 有好的 README 文档的项目不一定是一个好开源项目,但一个好开源项目一定有一个好的 README。 下面就简单的总
>>阅读原文<<
相关文章
1.
如何为开发项目编写规范的README文件
2.
Git学习:Readme文档的编写
3.
项目开发文档编写规范
4.
软件开发文档编写规范
5.
Markdown技术文档编写规范
6.
Android.mk文档规范
7.
swaggerApi文档规范
8.
开发工具总结(9)之开源项目的README文档的最全最规范写法
9.
文档规范和流程规范
10.
如何为开发项目编写规范的README文件(windows),此文详解
更多相关文章...
•
WSDL 文档
-
WSDL 教程
•
XSL-FO 文档
-
XSL-FO 教程
•
C# 中 foreach 遍历的用法
•
Docker容器实战(七) - 容器眼光下的文件系统
相关标签/搜索
readme
规范
文档
范文
中文文档
写文
法规
写法
写的
文件的读写
PHP教程
NoSQL教程
Redis教程
算法
文件系统
0
分享到微博
分享到微信
分享到QQ
每日一句
每一个你不满意的现在,都有一个你没有努力的曾经。
最新文章
1.
吴恩达深度学习--神经网络的优化(1)
2.
FL Studio钢琴卷轴之工具菜单的Riff命令
3.
RON
4.
中小企业适合引入OA办公系统吗?
5.
我的开源的MVC 的Unity 架构
6.
Ubuntu18 安装 vscode
7.
MATLAB2018a安装教程
8.
Vue之v-model原理
9.
【深度学习】深度学习之道:如何选择深度学习算法架构
本站公众号
欢迎关注本站公众号,获取更多信息
相关文章
1.
如何为开发项目编写规范的README文件
2.
Git学习:Readme文档的编写
3.
项目开发文档编写规范
4.
软件开发文档编写规范
5.
Markdown技术文档编写规范
6.
Android.mk文档规范
7.
swaggerApi文档规范
8.
开发工具总结(9)之开源项目的README文档的最全最规范写法
9.
文档规范和流程规范
10.
如何为开发项目编写规范的README文件(windows),此文详解
>>更多相关文章<<