如何编写友好的说明文档？

lochpure 的个人博客 / 0 / 3 / 创建于 6年前 / 更新于 6年前

一个优秀的项目应该有一个友好的说明文档，严格意义上讲，说明文档应该包括以下几点：

项目简介及创作动机
项目维护、CI、依赖更新状态（如果有）
features & 适用人群
运行的平台或硬件要求
重要依赖
如何安装与测试
使用示例及文档地址
贡献指南
License
鸣谢
其它特有的信息

本作品采用《CC 协议》，转载必须注明作者和本文链接

空舟湖上~ ——Jouzeyu

lochpure

版主 1.3k 声望

打工 @ 某不知名公司

每一个想要学习的瞬间，都有可能是未来的你在向你求救……

2 人点赞

你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程，JWT 概念及使用和 API 开发相关的进阶知识。

从零开始带你一步步开发一个 Go 博客项目，让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。

推荐文章：

更多推荐...

分享创造

价值千万的诊所saas项目正式开源 15 / 26 |

博客

Dcat-Plus-Admin：dcat-admin框架的超级增强版，开发效率提升200%！ 18 / 17 |

公告

Laravel 12 开始翻译/校对文档 16 / 18 |

博客

用 Laravel12 Startkit 做了一个 composer 私有包托管平台 😂 点赞超过 20 个开源，看看需要的人多不多 29 / 21 |

如何打造令后端面试官印象深刻的简历？ 16 / 10 |

博客

花了四个月打磨的 Laravel Plus 开源 35 / 104 |

讨论数量: 3

小李世界

Laravel 8.x 译者 2.0k 声望 / Doge 先锋 @ dogeow.com

不错，借鉴下，准备更新下文档 :+1:

6年前评论

caijunduo

课程读者 90 声望

6年前评论

839891627

课程读者 127 声望

附送 https://github.com/ruanyf/document-style-g...

6年前评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助

打工 @ 某不知名公司

私信

所有博文

文章归档

1 篇 2021 年 8 月 1 篇 2021 年 7 月 1 篇 2021 年 4 月 1 篇 2020 年 9 月 1 篇 2020 年 6 月 1 篇 2020 年 5 月 4 篇 2020 年 4 月 3 篇 2020 年 3 月 5 篇 2020 年 2 月 3 篇 2019 年 12 月 5 篇 2019 年 11 月 1 篇 2019 年 10 月 6 篇 2019 年 9 月

4年前从Git向Git-Flow出发 4年前从http到https你可以这样做 5年前 laravel线上环境表单验证重定向问题解决方案 5年前 mac 10.15版本使用 phpize 命令解决方案 6年前 Ubuntu 搭建 Yapi 接口文档平台

83 使用 Git 实现 Laravel 项目的自动化部署 75 记录一下常用的拓展包（2020/4/22 更新） 33 我们为什么很难坚持下去 32 从零开始搭建一个 demo 项目 17 安装 Laravel/horizon 踩过的坑

博客标签

enum

git

跨域

桶排序

拓展包推荐

个人感悟

踩坑记录

编码相关

拿来即用系列

Jou的解决方案系列

成为赞助商

如何编写友好的说明文档？

推荐文章：

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

如何编写友好的说明文档？

推荐文章：

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

请登录