diff options
Diffstat (limited to 'doc/breaking_rules.md')
| -rw-r--r-- | doc/breaking_rules.md | 8 |
1 files changed, 6 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 |