feat(readable-doc): small summariser + readable-doc-spike (big), team style - #77
Merged
Merged
Conversation
…(big), toned to team style Two commands per the team's expectation (transcript unavailable; based on the finished unread-counter spike's structure + the 07-16 refinement readability feedback): - readable-doc (SMALL) is now a spike SUMMARISER: from a full spike/PRD it writes a separate <stem>-summary.md with a super-short TLDR, one all-in-one diagram, the recommendation, spike goals, still-open options, open questions, open risks, technical deltas (GraphQL/DB/query), additive migration, external deps, feature-flag strategy, and a link back. Does not overwrite the source. - readable-doc-spike (BIG) formats the full spike in the team-standard skeleton (metadata header, TLDR, background, goals, architecture diagrams, per-goal investigation with verdicts, options+recommendation, considered-but-rejected, DB/GraphQL/query changes, migration, cross-project deps, testing, effort, phasing [multi-phase only], feature-flag, risks, open questions, verification appendix). - Both drop the prior emoji/small-caps-tag/table+diagram overload for a clean team style, keep the plannotator-safe correctness matrix, and adopt the team readability rule: narrative-first, cut buried ticket-number citations from prose (provenance in header/references). write-spike unchanged. Frontmatter YAML gate green; 31 skills.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Splits readable-doc into two commands per the team's expectation. readable-doc (SMALL) becomes a spike SUMMARISER (full spike -> separate -summary.md: tiny TLDR, one diagram, recommendation, goals, still-open options, open questions, open risks, GraphQL/DB/query deltas, additive migration, external deps, feature-flag, link back). readable-doc-spike (BIG) formats the full spike in the team-standard skeleton (metadata header, TLDR, background, goals, architecture diagrams, per-goal investigation with verdicts, options+recommendation, considered-but-rejected, technical changes, migration, deps, testing, effort, phasing[multi-phase only], feature-flag, risks, open questions, verification appendix). Both drop the emoji/tag/table overload for clean team style, keep the plannotator-safe matrix, and cut buried ticket-number citations from prose. write-spike unchanged. Based on the finished unread-counter spike structure + 07-16 refinement readability feedback (transcript was not accessible).