diff options
| author | Darren Bane <dbane@tilde.institute> | 2020-10-09 20:17:38 +0100 |
|---|---|---|
| committer | Darren Bane <dbane@tilde.institute> | 2020-10-09 20:17:38 +0100 |
| commit | 08296c9356bd265eb2b077dfd3888488ea229b2a (patch) | |
| tree | 3a4ef88d89f0381f49e771de580d028bb9dee038 /doc | |
| parent | 249656ed94a1ea851654951057e1f9ea0278f763 (diff) | |
| download | lsp-08296c9356bd265eb2b077dfd3888488ea229b2a.tar.gz | |
Minor doc tweaks
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/breaking_rules.md | 8 | ||||
| -rw-r--r-- | doc/refs | 4 |
2 files changed, 10 insertions, 2 deletions
diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md index 38abe77..b8887b3 100644 --- a/doc/breaking_rules.md +++ b/doc/breaking_rules.md @@ -116,11 +116,15 @@ Even though this is a prototype, attention should be paid to basic craftsmanship \.[ preston-werner 2010 \.] -and man pages +and man (actually, mdoc) pages \.[ -collyer cox +dzonsons \.] . +* Certain parts of a system justify greater detail for a *complete* specification. + These are (newly-designed) network protocols and complex persistent data models. + If there is no standard protocol, I recommend using JSON-RPC as a base and following the documentation style of LSP. + The data models should be documented as commented SQL DDL. ### Run-time type-checking diff --git a/doc/refs b/doc/refs index d380cf2..7fb0ad2 100644 --- a/doc/refs +++ b/doc/refs @@ -1025,6 +1025,10 @@ %T How to Write a Plan 9 Manual Page %O available: http://www.vitanuova.com/inferno/papers/manhow.pdf [accessed 27 May 2020] +%A Kristaps Dzonsons +%T Practical UNIX Manuals +%O available: https://manpages.bsd.lv/toc.html [accessed 9 Oct 2020] + %T Basic English %B Wikipedia %O available: https://en.wikipedia.org/wiki/Basic_English [accessed 28 May 2020] |