kingmadoc 0.3.0.dev15__tar.gz → 0.3.0.dev16__tar.gz

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: kingmadoc
-Version: 0.3.0.dev15
+Version: 0.3.0.dev16
 Summary: Feature docs for AI coding agents: a plan with C4 diagrams before the code, a verification doc after.
 Project-URL: Homepage, https://github.com/ATkingma/KingmaDoc
 Project-URL: Issues, https://github.com/ATkingma/KingmaDoc/issues

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/skill/SKILL.md

@@ -145,7 +145,8 @@ the diagrams, but never beyond what the user said or the code shows.
   vague REQ or invented ones. Under each: `Verified by: <test, test case or command>`
   (or `_TODO_`).
 - **Planned changes**: per `files_expected` path what changes and why (the "how" of
-  answer 4), one to three lines, no code blocks. Risks and assumptions may add code
+  answer 4), one to three lines, no code blocks; where a code snippet would help
+  (a new method, a changed signature), draw a small `classDiagram` with just those members. Risks and assumptions may add code
   findings marked _(inferred)_.
 - **Generated**: the real system time (`date -Iminutes`).
 - External systems: those from answer 3, plus systems the code demonstrably uses

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/skill/codex.md

@@ -145,7 +145,8 @@ the diagrams, but never beyond what the user said or the code shows.
   vague REQ or invented ones. Under each: `Verified by: <test, test case or command>`
   (or `_TODO_`).
 - **Planned changes**: per `files_expected` path what changes and why (the "how" of
-  answer 4), one to three lines, no code blocks. Risks and assumptions may add code
+  answer 4), one to three lines, no code blocks; where a code snippet would help
+  (a new method, a changed signature), draw a small `classDiagram` with just those members. Risks and assumptions may add code
   findings marked _(inferred)_.
 - **Generated**: the real system time (`date -Iminutes`).
 - External systems: those from answer 3, plus systems the code demonstrably uses
@@ -373,7 +374,8 @@ files_expected: [<existing files or folders the user said will change>]
 ## Planned changes
 
 - `<path from files_expected>`: <what changes and why, one to three lines, no code
-  blocks; the "how" from answer 4, or> _TODO: what changes here and why._
+  blocks (a small classDiagram with the changed members instead of a snippet); the "how"
+  from answer 4, or> _TODO: what changes here and why._
 
 ## Requirements
 

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/skill/copilot.md

@@ -145,7 +145,8 @@ the diagrams, but never beyond what the user said or the code shows.
   vague REQ or invented ones. Under each: `Verified by: <test, test case or command>`
   (or `_TODO_`).
 - **Planned changes**: per `files_expected` path what changes and why (the "how" of
-  answer 4), one to three lines, no code blocks. Risks and assumptions may add code
+  answer 4), one to three lines, no code blocks; where a code snippet would help
+  (a new method, a changed signature), draw a small `classDiagram` with just those members. Risks and assumptions may add code
   findings marked _(inferred)_.
 - **Generated**: the real system time (`date -Iminutes`).
 - External systems: those from answer 3, plus systems the code demonstrably uses
@@ -373,7 +374,8 @@ files_expected: [<existing files or folders the user said will change>]
 ## Planned changes
 
 - `<path from files_expected>`: <what changes and why, one to three lines, no code
-  blocks; the "how" from answer 4, or> _TODO: what changes here and why._
+  blocks (a small classDiagram with the changed members instead of a snippet); the "how"
+  from answer 4, or> _TODO: what changes here and why._
 
 ## Requirements
 

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/skill/cursor.md

@@ -146,7 +146,8 @@ the diagrams, but never beyond what the user said or the code shows.
   vague REQ or invented ones. Under each: `Verified by: <test, test case or command>`
   (or `_TODO_`).
 - **Planned changes**: per `files_expected` path what changes and why (the "how" of
-  answer 4), one to three lines, no code blocks. Risks and assumptions may add code
+  answer 4), one to three lines, no code blocks; where a code snippet would help
+  (a new method, a changed signature), draw a small `classDiagram` with just those members. Risks and assumptions may add code
   findings marked _(inferred)_.
 - **Generated**: the real system time (`date -Iminutes`).
 - External systems: those from answer 3, plus systems the code demonstrably uses
@@ -374,7 +375,8 @@ files_expected: [<existing files or folders the user said will change>]
 ## Planned changes
 
 - `<path from files_expected>`: <what changes and why, one to three lines, no code
-  blocks; the "how" from answer 4, or> _TODO: what changes here and why._
+  blocks (a small classDiagram with the changed members instead of a snippet); the "how"
+  from answer 4, or> _TODO: what changes here and why._
 
 ## Requirements
 

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/skill/explaining-code/SKILL.md

@@ -41,7 +41,8 @@ Rules:
   stops it; never a proposal.
 - **Picture, caption, table. No stories.** Every figure has a numbered caption
   (`**Figure 3.** …`, no gaps) and at most three sentences; a table decodes it. Never
-  describe a diagram in prose, never paste code as an image, no filler.
+  describe a diagram in prose, never paste code as an image, no filler. Where a code
+  snippet would explain a class or signature, draw a small UML class diagram instead.
 - **Zoom in step by step,** one small diagram per level (at most about fifteen elements).
 - **Every figure follows its model's notation** ([reference/c4-model.md](reference/c4-model.md),
   [reference/models.md](reference/models.md)) and passes its checklist: a title, a

{kingmadoc-0.3.0.dev15 → kingmadoc-0.3.0.dev16}/skill/reference/formats.md

@@ -44,7 +44,8 @@ files_expected: [<existing files or folders the user said will change>]
 ## Planned changes
 
 - `<path from files_expected>`: <what changes and why, one to three lines, no code
-  blocks; the "how" from answer 4, or> _TODO: what changes here and why._
+  blocks (a small classDiagram with the changed members instead of a snippet); the "how"
+  from answer 4, or> _TODO: what changes here and why._
 
 ## Requirements