完成项目用例
您的项目用户指南可能包含多个 .md 文件。每个文件应涵盖项目的一个主要用例或“用户故事”。最佳提纲如下所示。一般来说,这些页面的标题应该以动词开头。例如,Completing
而不是 Complete
。
理解 xxx
在这里,您描述了 XXX 是什么以及用户为什么要关心。它为他们解决了什么问题,等等。这是一个 说明部分。
如何 xxx
您可以更改标题,但本节是一个 步骤,它展示了实现目标的确切步骤。它应该是一组编号的步骤。
- 执行此操作。
bash cli 示例、yaml 示例等
-
执行其他操作。
-
验证此项。