honestdocs 0.0.0-stage → 0.1.0

package/templates/research.md

@@ -0,0 +1,20 @@
+# {{title}}
+
+## Question
+
+_One question, specific enough that you can tell when it is answered._
+
+## Findings
+
+_With sources — a link, a measurement, a file and line. A finding nobody can check is an
+opinion._
+
+## Implications
+
+_What this means for the project: what to do, what not to do, what is still unknown._
+
+## Alternatives considered
+
+_Approaches looked at and set aside, and why._
+
+## Open questions

package/templates/rule.md

@@ -0,0 +1,20 @@
+# {{title}}
+
+_Rules that every change in their scope must keep. Edit them here, in place, when they
+change, and add a line to the Log. Never a second document beside this one._
+
+## Scope
+
+_What these rules are about, and what kind of change has to read them first._
+
+## Rules
+
+_One list item per rule, its id in bold. A rule that can be a test is one: name the test
+on an indented `Test:` line under the rule, the path in backticks, and `honestdocs check`
+fails if that file disappears._
+
+- **X1** State the rule as something a reviewer can answer yes or no to.
+
+## Log
+
+_Dated one-liners: which rule changed and why._