README模板

  • Z时代
  • 2024-01-10
  • 分类：综合

编程

1.前言

  出于对项目长期开发和维护的需要，无论是开源项目还是公司内部的业务项目都应该书写详细的README文档，存储该项目的所有相关信息与文档链接。特给出如下模板：

# Name - 项目名称
（本节空置即可，不需要写内容）
## Introduction - 介绍
### Summary - 概要
概括地说明本项目的目的、使用场景即可。
### Features - 特性
## Requirements - 必要条件
环境，对所有项目，和所有子模块和库的描述。举出和普通web项目有区别的地方即可，比如本项目除了需要接收用户请求还需要解析消息队列的消息（这个服务压力好大）。
## Configuration - 配置
本软件的配置信息会因为环境不同而不同吗？需要选择环境吗？需要运维人员手动修改配置吗？
## Installation - 安装
如何安装或打包本项目？本项目是maven项目吗？还是Gradle项目？
## Usage - 用法
如何使用本软件？本软件是如何被其它项目使用的？本软件能否直接部署到服务器上？本软件怎么启动啊？
## Development - 开发
关于怎样开发的文档信息。（API 等。），需求文档的地址是什么？产品原型的地址是什么？有与其它公司对接时，暴露接口的说明文档地址什么？
## Changelog - 更新日志
只记录大版本更新，不要事无巨细地记录。
## FAQ - 常见问题
只记录初次接触本项目的开发人员最常问的问题，不要超过三个，每个问题最好能链接到issue。
## Support - 支持
### Dos - 文档（更多文档。）
软件或平台的使用说明书在线地址。
### Contact - 联系
可以使用table的格式标明开发者和邮箱联系方式
## Authors and acknowledgment - 贡献者和感谢
（除个别对公司进步影响巨大的项目，此节都可省略）
## License - 版权信息
版权和许可信息（或阅读许可证）、法律声明。公司内部项目必须声明只能内部使用，严禁外泄。

2.学习案例

  几近完美的在线示例请参看如下项目

  • pyecharts

3.参考文章

README 模板

以上是 README模板 的全部内容， 来源链接： utcz.com/z/511743.html

回到顶部