slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: contributing: four kinds of docs

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-10-23 10:34:59 -07:00
parent e0c511b5fc
commit 6f06b25ddb
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -1198,6 +1198,17 @@ tools/generatejournal 3 5 5 --mixed >examples/mixed.journal
## Docs
### Four kinds of documentation
<div style="margin:1em 2em; font-style:italic;">
"There is a secret that needs to be understood in order to write good
software documentation: there isn’t one thing called documentation,
there are four. They are: tutorials, how-to guides, explanation and
technical reference. They represent four different purposes or
functions, and require four different approaches to their creation."
--[Daniele Procida] (https://news.ycombinator.com/item?id=21289832)
</div>
https://github.com/simonmichael/hledger/tree/master/doc
Project documentation lives in a number of places: