Skip to content

Commit 783c38f

Browse files
committed
Add section for user level documentation.
1 parent 983aad6 commit 783c38f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

project-setup/templates/README-template.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@ This section should contain brief documentation written for first time users on
1717
how to get started using the project. Further more detailed documentation can be
1818
linked to from here.
1919

20+
## Further information
21+
22+
This section can list any or all of the following:
23+
24+
* A list of features, use cases that the software addresses.
25+
* Information on design principles that are used to resolve trade-offs
26+
* Links to further user level documentation
27+
* Answers to frequently asked questions (FAQ), preferably in a format that
28+
allows to link to specific questions and their answers for easier reference.
29+
2030
## Getting help
2131

2232
This section should contain a brief documentation on how to get help for the

0 commit comments

Comments
 (0)