wiki-assessment · diff
git:20260822.49422ae to git:20260903.60a41b1
199 added, 199 removed. Audit A to C.
- ---
- type: "core"
- name: "wiki-assessment"
- status: "stable"
- description: "Audits the wiki by walking each of the 19 core docs one by one, asking 5-8 verification questions per doc to surface drift, gaps, and stale content. The wiki is the brain — if it drifts, the next AI agent makes bad decisions from it."
- references: "references/verify-0X-*.md — 19 verification question sets (one per core doc) used to walk the wiki one doc at a time."
- ---
-
- # wiki-assessment
-
- This skill audits an existing project's documentation library by walking through each of the 19 core wiki docs **one at a time** and asking the user 5–8 targeted verification questions per doc to surface drift, gaps, and stale content.
-
- > **CRITICAL**
- > **The wiki is the brain of the app.** Every AI coding agent reads it before making decisions. A wiki that has drifted from the code is a wiki that lies to the next agent. Verification is cheaper than rework — a 5-minute audit prevents a 5-hour bug hunt.
-
- This skill exists to surface what's wrong, in order, so it can be fixed.
-
- ---
-
- ## 1. Core Philosophy
-
- | Principle | Meaning |
- | :--- | :--- |
- | **Drift is dangerous** | A doc that was true 6 months ago and isn't true now is worse than no doc. |
- | **Per-Doc Attention** | Each of the 19 core docs gets a deliberate pass. No bulk "looks fine." |
- | **Never silently fix** | Audit findings go to the user. The user decides what to fix and when. |
- | **Gap → Report → Fix** | Surface gaps as a structured report; remediation is a separate, user-driven step. |
-
- ---
-
- ## 2. The Verification Loop (Core Workflow)
-
- This is the **only** way this skill operates. Do not skim. Do not batch.
-
- ```mermaid
- flowchart TD
- Start[Load skill] --> Hub[Doc 00: System Index]
- Hub --> Read1[Read .wiki/core/00-system-index.md]
- Read1 --> V1[Open references/verify-00-system-index.md]
- V1 --> Check1[Cross-check doc vs code/state]
- Check1 --> Ask1[Ask user the 5-8 verification questions]
- Ask1 --> Record1[Record verdict: ✅ / ⚠ / ❌]
- Record1 --> Next1{User approve findings?}
- Next1 -->|yes| Next2[Move to doc 01]
- Next1 -->|discuss| Ask1
- Next2 --> Read2[Read 01-*.md]
- Read2 --> V2[Open verify-01-*.md]
- V2 --> Check2[Cross-check]
- Check2 --> Ask2[Ask questions]
- Ask2 --> Record2[Record verdict]
- Record2 --> Next3[...]
- Next3 --> Final[Doc 18: Knowledge Capture]
- Final --> Report[Compile Gap Report]
- Report --> Done[All 19 docs verified]
- ```
-
- ### For each of the 19 core docs (`00` → `18`):
-
- 1. **Read the doc** at `.wiki/core/0X-name.md`.
- 2. **Open the verification set** at `references/verify-0X-name.md` for the current slot.
- 3. **Cross-check the doc against reality** — code, configs, state, recent commits. Use `grep`, `ls`, and `read` to verify.
- 4. **Ask the user** the 5–8 verification questions. These are "does it match" questions, not "what is" questions. The agent is the one gathering evidence; the user confirms interpretation.
- 5. **Record a verdict** for the doc:
- - ✅ **Accurate** — doc matches reality.
- - ⚠ **Drift** — doc is partially correct but has stale or incomplete content.
- - ❌ **Missing or wrong** — doc is absent, contradicts reality, or has major gaps.
- 6. **Checkpoint with the user** before moving to the next doc. Confirm the verdict and the specific findings.
- 7. **Repeat** for the next slot in `00` → `18` order.
-
- > **DO NOT** silently fix the doc. That's a separate workflow (use `wiki-bootstrap` to re-elicit content for drifted slots).
- >
- > **DO NOT** mark a doc as ✅ without actually checking. "Looks fine" is not verification.
- >
- > **DO** record specific evidence (file paths, commit hashes, configuration values) for any ⚠ or ❌ verdict.
-
- ---
-
- ## 3. Verification Set Reference Table
-
- When you reach slot `0X`, open this file to read its verification question set:
-
- | Slot | Doc | Verification Set |
- | :--- | :--- | :--- |
- | 00 | System Index (The Hub) | `references/verify-00-system-index.md` |
- | 01 | Vision & North Star | `references/verify-01-vision-north-star.md` |
- | 02 | Product Context | `references/verify-02-product-context.md` |
- | 03 | Glossary of Terms | `references/verify-03-glossary-of-terms.md` |
- | 04 | State & Context | `references/verify-04-state-context.md` |
- | 05 | Core Architecture | `references/verify-05-core-architecture.md` |
- | 06 | Directory Structure | `references/verify-06-directory-structure.md` |
- | 07 | App Structure | `references/verify-07-app-structure.md` |
- | 08 | User Journey | `references/verify-08-user-journey.md` |
- | 09 | Design System | `references/verify-09-design-system.md` |
- | 10 | Validation Standards | `references/verify-10-validation-standards.md` |
- | 11 | Utility Standards | `references/verify-11-utility-standards.md` |
- | 12 | Security Standards | `references/verify-12-security-standards.md` |
- | 13 | Performance Standards | `references/verify-13-performance-standards.md` |
- | 14 | Testing Standards | `references/verify-14-testing-standards.md` |
- | 15 | AI Features | `references/verify-15-ai-features.md` |
- | 16 | External Integrations | `references/verify-16-external-integrations.md` |
- | 17 | Docs Blueprint | `references/verify-17-docs-blueprint.md` |
- | 18 | Knowledge Capture | `references/verify-18-knowledge-capture.md` |
-
- Each verification file follows this shape:
-
- - **Why this doc matters to AI agents** — what decisions the next agent will make from this doc.
- - **Required sections (sanity check)** — the must-have structure for the doc.
- - **Questions to ask** — 5–8 "does it match" questions, in order.
- - **What to verify against** — code paths, configs, or external systems to cross-check.
-
- ---
-
- ## 4. The Gap Report (Final Output)
-
- After walking all 19 docs, compile a single structured report. The user uses this to prioritize remediation.
-
- ```markdown
- # Wiki Gap Report — [YYYY-MM-DD]
-
- ## Summary
- - ✅ Accurate: <count>
- - ⚠ Drift: <count>
- - ❌ Missing/Wrong: <count>
-
- ## Findings by Slot
-
- ### 00 — System Index
- - Verdict: ✅ / ⚠ / ❌
- - Evidence: <file paths, commit hashes, config values>
- - Specific drift/gap: <description>
- - Suggested fix: <re-elicit via wiki-bootstrap, or specific edit>
-
- ### 01 — Vision & North Star
- - Verdict: …
- - …
- (continue for all 19 slots)
-
- ## Prioritized Remediation
- 1. (Critical) Doc 13 — Security Standards: documented RLS doesn't match firestore.rules
- 2. (High) Doc 07 — State Context: useAuth() signature drifted; return shape missing logout()
- 3. (Medium) Doc 04 — Directory Structure: new `src/hooks/` not documented
- 4. (Low) Doc 16 — Glossary: term "scope" used in code but not defined here
- ```
-
- The agent **does not** apply the fixes. The user reviews the report and decides what to act on. Once a fix is approved, the agent can either run `wiki-bootstrap` on the affected slot (re-elicit content from scratch) or make targeted edits per the user's direction.
-
- ---
-
- ## 5. Lifecycle Operations (YAML & Index Syncing)
-
- When remediating audit findings (either as part of the audit or as a follow-up), apply these rules:
-
- ### A. Progressive Version Control (YAML)
- Every created or modified file must update its YAML frontmatter. Mark superseded docs with `status: "deprecated"` or move them to a `deprecated/` subfolder.
-
- ### B. Table of Contents Syncing
- When adding or deleting files, update the corresponding category index:
-
- - `.wiki/features/features-index.md`
- - `.wiki/components/components-index.md`
- - `.wiki/database/database-index.md`
- - `.wiki/logic/logic-index.md`
- - `.devops/backlog/backlog-index.md` (operational)
-
- ### C. Project Audit Logging (The Wrap-Up Protocol)
- Whenever an audit is complete or a finding is remediated, append a chronological entry to `.devops/logs/agent-changelog.md` using this exact format:
-
- ```markdown
- ## [YYYY-MM-DD HH:MM] — <Task/Feature Name>
- **Agent:** <Agent Name>
- **Files Modified:**
- - `src/...`
- - `.wiki/...`
- **Database Changes:** None (or list migrations)
- **Summary:** <One-sentence summary>
- ```
-
- ---
-
- ## 6. Quick Triage Pre-Scan (Optional, Before the Loop)
-
- Before walking the 19 docs in order, you may optionally read `.devops/logs/agent-changelog.md` to surface recently modified features. Use this to **prioritize** which slots to scrutinize first — it is **not** a substitute for the full per-doc loop. The full walk is always required regardless of what the changelog reveals.
-
- ---
-
- ## 7. When to Use This Skill
-
- - **Routine audits** — quarterly, or after a major feature ships.
- - **Pre-deployment vibes check** — paired with `pre-deployment-vibe-auditor` to catch doc drift before it ships.
- - **Suspected drift** — user says "the wiki feels stale" or "this code doesn't match what the doc says."
- - **Onboarding a new project** — when handed an unfamiliar codebase, use this to surface what's known vs. what's missing before making changes.
-
- For bootstrapping a new wiki from scratch, use the companion skill: **`wiki-bootstrap`**.
-
- ---
-
- > **The Golden Rule**
- > If a feature's behavior changes in code, the documentation **MUST** be updated in the same PR/Conversation. Outdated documentation is technical debt that misleads every AI agent that reads it next.
-
+ ��- - -
+ t y p e : " c o r e "
+ n a m e : " w i k i - a s s e s s m e n t "
+ s t a t u s : " s t a b l e "
+ d e s c r i p t i o n : " A u d i t s t h e w i k i b y w a l k i n g e a c h o f t h e 1 9 c o r e d o c s o n e b y o n e , a s k i n g 5 - 8 v e r i f i c a t i o n q u e s t i o n s p e r d o c t o s u r f a c e d r i f t , g a p s , a n d s t a l e c o n t e n t . T h e w i k i i s t h e b r a i n �� � i f i t d r i f t s , t h e n e x t A I a g e n t m a k e s b a d d e c i s i o n s f r o m i t . "
+ r e f e r e n c e s : " r e f e r e n c e s / v e r i f y - 0 X - * . m d �� � 1 9 v e r i f i c a t i o n q u e s t i o n s e t s ( o n e p e r c o r e d o c ) u s e d t o w a l k t h e w i k i o n e d o c a t a t i m e . "
+ - - -
+
+ # w i k i - a s s e s s m e n t
+
+ T h i s s k i l l a u d i t s a n e x i s t i n g p r o j e c t ' s d o c u m e n t a t i o n l i b r a r y b y w a l k i n g t h r o u g h e a c h o f t h e 1 9 c o r e w i k i d o c s * * o n e a t a t i m e * * a n d a s k i n g t h e u s e r 5 �� � 8 t a r g e t e d v e r i f i c a t i o n q u e s t i o n s p e r d o c t o s u r f a c e d r i f t , g a p s , a n d s t a l e c o n t e n t .
+
+ > * * C R I T I C A L * *
+ > * * T h e w i k i i s t h e b r a i n o f t h e a p p . * * E v e r y A I c o d i n g a g e n t r e a d s i t b e f o r e m a k i n g d e c i s i o n s . A w i k i t h a t h a s d r i f t e d f r o m t h e c o d e i s a w i k i t h a t l i e s t o t h e n e x t a g e n t . V e r i f i c a t i o n i s c h e a p e r t h a n r e w o r k �� � a 5 - m i n u t e a u d i t p r e v e n t s a 5 - h o u r b u g h u n t .
+
+ T h i s s k i l l e x i s t s t o s u r f a c e w h a t ' s w r o n g , i n o r d e r , s o i t c a n b e f i x e d .
+
+ - - -
+
+ # # 1 . C o r e P h i l o s o p h y
+
+ | P r i n c i p l e | M e a n i n g |
+ | : - - - | : - - - |
+ | * * D r i f t i s d a n g e r o u s * * | A d o c t h a t w a s t r u e 6 m o n t h s a g o a n d i s n ' t t r u e n o w i s w o r s e t h a n n o d o c . |
+ | * * P e r - D o c A t t e n t i o n * * | E a c h o f t h e 1 9 c o r e d o c s g e t s a d e l i b e r a t e p a s s . N o b u l k " l o o k s f i n e . " |
+ | * * N e v e r s i l e n t l y f i x * * | A u d i t f i n d i n g s g o t o t h e u s e r . T h e u s e r d e c i d e s w h a t t o f i x a n d w h e n . |
+ | * * G a p �� � R e p o r t �� � F i x * * | S u r f a c e g a p s a s a s t r u c t u r e d r e p o r t ; r e m e d i a t i o n i s a s e p a r a t e , u s e r - d r i v e n s t e p . |
+
+ - - -
+
+ # # 2 . T h e V e r i f i c a t i o n L o o p ( C o r e W o r k f l o w )
+
+ T h i s i s t h e * * o n l y * * w a y t h i s s k i l l o p e r a t e s . D o n o t s k i m . D o n o t b a t c h .
+
+ ` ` ` m e r m a i d
+ f l o w c h a r t T D
+ S t a r t [ L o a d s k i l l ] - - > H u b [ D o c 0 0 : S y s t e m I n d e x ]
+ H u b - - > R e a d 1 [ R e a d . w i k i / c o r e / 0 0 - s y s t e m - i n d e x . m d ]
+ R e a d 1 - - > V 1 [ O p e n r e f e r e n c e s / v e r i f y - 0 0 - s y s t e m - i n d e x . m d ]
+ V 1 - - > C h e c k 1 [ C r o s s - c h e c k d o c v s c o d e / s t a t e ]
+ C h e c k 1 - - > A s k 1 [ A s k u s e r t h e 5 - 8 v e r i f i c a t i o n q u e s t i o n s ]
+ A s k 1 - - > R e c o r d 1 [ R e c o r d v e r d i c t : �� � / �� � / �� � ]
+ R e c o r d 1 - - > N e x t 1 { U s e r a p p r o v e f i n d i n g s ? }
+ N e x t 1 - - > | y e s | N e x t 2 [ M o v e t o d o c 0 1 ]
+ N e x t 1 - - > | d i s c u s s | A s k 1
+ N e x t 2 - - > R e a d 2 [ R e a d 0 1 - * . m d ]
+ R e a d 2 - - > V 2 [ O p e n v e r i f y - 0 1 - * . m d ]
+ V 2 - - > C h e c k 2 [ C r o s s - c h e c k ]
+ C h e c k 2 - - > A s k 2 [ A s k q u e s t i o n s ]
+ A s k 2 - - > R e c o r d 2 [ R e c o r d v e r d i c t ]
+ R e c o r d 2 - - > N e x t 3 [ . . . ]
+ N e x t 3 - - > F i n a l [ D o c 1 8 : K n o w l e d g e C a p t u r e ]
+ F i n a l - - > R e p o r t [ C o m p i l e G a p R e p o r t ]
+ R e p o r t - - > D o n e [ A l l 1 9 d o c s v e r i f i e d ]
+ ` ` `
+
+ # # # F o r e a c h o f t h e 1 9 c o r e d o c s ( ` 0 0 ` �� � ` 1 8 ` ) :
+
+ 1 . * * R e a d t h e d o c * * a t ` . w i k i / c o r e / 0 X - n a m e . m d ` .
+ 2 . * * O p e n t h e v e r i f i c a t i o n s e t * * a t ` r e f e r e n c e s / v e r i f y - 0 X - n a m e . m d ` f o r t h e c u r r e n t s l o t .
+ 3 . * * C r o s s - c h e c k t h e d o c a g a i n s t r e a l i t y * * �� � c o d e , c o n f i g s , s t a t e , r e c e n t c o m m i t s . U s e ` g r e p ` , ` l s ` , a n d ` r e a d ` t o v e r i f y .
+ 4 . * * A s k t h e u s e r * * t h e 5 �� � 8 v e r i f i c a t i o n q u e s t i o n s . T h e s e a r e " d o e s i t m a t c h " q u e s t i o n s , n o t " w h a t i s " q u e s t i o n s . T h e a g e n t i s t h e o n e g a t h e r i n g e v i d e n c e ; t h e u s e r c o n f i r m s i n t e r p r e t a t i o n .
+ 5 . * * R e c o r d a v e r d i c t * * f o r t h e d o c :
+ - �� � * * A c c u r a t e * * �� � d o c m a t c h e s r e a l i t y .
+ - �� � * * D r i f t * * �� � d o c i s p a r t i a l l y c o r r e c t b u t h a s s t a l e o r i n c o m p l e t e c o n t e n t .
+ - �� � * * M i s s i n g o r w r o n g * * �� � d o c i s a b s e n t , c o n t r a d i c t s r e a l i t y , o r h a s m a j o r g a p s .
+ 6 . * * C h e c k p o i n t w i t h t h e u s e r * * b e f o r e m o v i n g t o t h e n e x t d o c . C o n f i r m t h e v e r d i c t a n d t h e s p e c i f i c f i n d i n g s .
+ 7 . * * R e p e a t * * f o r t h e n e x t s l o t i n ` 0 0 ` �� � ` 1 8 ` o r d e r .
+
+ > * * D O N O T * * s i l e n t l y f i x t h e d o c . T h a t ' s a s e p a r a t e w o r k f l o w ( u s e ` w i k i - b o o t s t r a p ` t o r e - e l i c i t c o n t e n t f o r d r i f t e d s l o t s ) .
+ >
+ > * * D O N O T * * m a r k a d o c a s �� � w i t h o u t a c t u a l l y c h e c k i n g . " L o o k s f i n e " i s n o t v e r i f i c a t i o n .
+ >
+ > * * D O * * r e c o r d s p e c i f i c e v i d e n c e ( f i l e p a t h s , c o m m i t h a s h e s , c o n f i g u r a t i o n v a l u e s ) f o r a n y �� � o r �� � v e r d i c t .
+
+ - - -
+
+ # # 3 . V e r i f i c a t i o n S e t R e f e r e n c e T a b l e
+
+ W h e n y o u r e a c h s l o t ` 0 X ` , o p e n t h i s f i l e t o r e a d i t s v e r i f i c a t i o n q u e s t i o n s e t :
+
+ | S l o t | D o c | T h e m e | V e r i f i c a t i o n S e t |
+ | : - - - | : - - - | : - - - | : - - - |
+ | 0 0 | S y s t e m I n d e x ( T h e H u b ) | H u b | ` r e f e r e n c e s / v e r i f y - 0 0 - s y s t e m - i n d e x . m d ` |
+ | 0 1 | V i s i o n & N o r t h S t a r | S t r a t e g y | ` r e f e r e n c e s / v e r i f y - 0 1 - v i s i o n - n o r t h - s t a r . m d ` |
+ | 0 2 | P r o d u c t C o n t e x t | S t r a t e g y | ` r e f e r e n c e s / v e r i f y - 0 2 - p r o d u c t - c o n t e x t . m d ` |
+ | 0 3 | G l o s s a r y o f T e r m s | S t r a t e g y | ` r e f e r e n c e s / v e r i f y - 0 3 - g l o s s a r y - o f - t e r m s . m d ` |
+ | 0 4 | S t a t e & C o n t e x t | A r c h i t e c t u r e | ` r e f e r e n c e s / v e r i f y - 0 4 - s t a t e - c o n t e x t . m d ` |
+ | 0 5 | C o r e A r c h i t e c t u r e | A r c h i t e c t u r e | ` r e f e r e n c e s / v e r i f y - 0 5 - c o r e - a r c h i t e c t u r e . m d ` |
+ | 0 6 | D i r e c t o r y S t r u c t u r e | A r c h i t e c t u r e | ` r e f e r e n c e s / v e r i f y - 0 6 - d i r e c t o r y - s t r u c t u r e . m d ` |
+ | 0 7 | A p p S t r u c t u r e | A r c h i t e c t u r e | ` r e f e r e n c e s / v e r i f y - 0 7 - a p p - s t r u c t u r e . m d ` |
+ | 0 8 | U s e r J o u r n e y | W o r k f l o w | ` r e f e r e n c e s / v e r i f y - 0 8 - u s e r - j o u r n e y . m d ` |
+ | 0 9 | D e s i g n S y s t e m | D e s i g n | ` r e f e r e n c e s / v e r i f y - 0 9 - d e s i g n - s y s t e m . m d ` |
+ | 1 0 | V a l i d a t i o n S t a n d a r d s | S t a n d a r d s | ` r e f e r e n c e s / v e r i f y - 1 0 - v a l i d a t i o n - s t a n d a r d s . m d ` |
+ | 1 1 | U t i l i t y S t a n d a r d s | S t a n d a r d s | ` r e f e r e n c e s / v e r i f y - 1 1 - u t i l i t y - s t a n d a r d s . m d ` |
+ | 1 2 | S e c u r i t y S t a n d a r d s | S t a n d a r d s | ` r e f e r e n c e s / v e r i f y - 1 2 - s e c u r i t y - s t a n d a r d s . m d ` |
+ | 1 3 | P e r f o r m a n c e S t a n d a r d s | S t a n d a r d s | ` r e f e r e n c e s / v e r i f y - 1 3 - p e r f o r m a n c e - s t a n d a r d s . m d ` |
+ | 1 4 | * ( T e s t i n g S t a n d a r d s h a n d l e d b y t e s t i n g / * s u b t r e e ) * | | |
+ | 1 5 | A I F e a t u r e s | F e a t u r e s | ` r e f e r e n c e s / v e r i f y - 1 5 - a i - f e a t u r e s . m d ` |
+ | 1 6 | E x t e r n a l I n t e g r a t i o n s | F e a t u r e s | ` r e f e r e n c e s / v e r i f y - 1 6 - e x t e r n a l - i n t e g r a t i o n s . m d ` |
+ | 1 7 | D o c s B l u e p r i n t | M e t a | ` r e f e r e n c e s / v e r i f y - 1 7 - d o c s - b l u e p r i n t . m d ` |
+ | 1 8 | K n o w l e d g e C a p t u r e | M e t a | ` r e f e r e n c e s / v e r i f y - 1 8 - k n o w l e d g e - c a p t u r e . m d ` |
+
+ E a c h v e r i f i c a t i o n f i l e f o l l o w s t h i s s h a p e :
+
+ - * * W h y t h i s d o c m a t t e r s t o A I a g e n t s * * �� � w h a t d e c i s i o n s t h e n e x t a g e n t w i l l m a k e f r o m t h i s d o c .
+ - * * R e q u i r e d s e c t i o n s ( s a n i t y c h e c k ) * * �� � t h e m u s t - h a v e s t r u c t u r e f o r t h e d o c .
+ - * * Q u e s t i o n s t o a s k * * �� � 5 �� � 8 " d o e s i t m a t c h " q u e s t i o n s , i n o r d e r .
+ - * * W h a t t o v e r i f y a g a i n s t * * �� � c o d e p a t h s , c o n f i g s , o r e x t e r n a l s y s t e m s t o c r o s s - c h e c k .
+
+ - - -
+
+ # # 4 . T h e G a p R e p o r t ( F i n a l O u t p u t )
+
+ A f t e r w a l k i n g a l l 1 9 d o c s , c o m p i l e a s i n g l e s t r u c t u r e d r e p o r t . T h e u s e r u s e s t h i s t o p r i o r i t i z e r e m e d i a t i o n .
+
+ ` ` ` m a r k d o w n
+ # W i k i G a p R e p o r t �� � [ Y Y Y Y - M M - D D ]
+
+ # # S u m m a r y
+ - �� � A c c u r a t e : < c o u n t >
+ - �� � D r i f t : < c o u n t >
+ - �� � M i s s i n g / W r o n g : < c o u n t >
+
+ # # F i n d i n g s b y S l o t
+
+ # # # 0 0 �� � S y s t e m I n d e x
+ - V e r d i c t : �� � / �� � / �� �
+ - E v i d e n c e : < f i l e p a t h s , c o m m i t h a s h e s , c o n f i g v a l u e s >
+ - S p e c i f i c d r i f t / g a p : < d e s c r i p t i o n >
+ - S u g g e s t e d f i x : < r e - e l i c i t v i a w i k i - b o o t s t r a p , o r s p e c i f i c e d i t >
+
+ # # # 0 1 �� � V i s i o n & N o r t h S t a r
+ - V e r d i c t : �� �
+ - �� �
+ ( c o n t i n u e f o r a l l 1 9 s l o t s )
+
+ # # P r i o r i t i z e d R e m e d i a t i o n
+ 1 . ( C r i t i c a l ) D o c 1 3 �� � S e c u r i t y S t a n d a r d s : d o c u m e n t e d R L S d o e s n ' t m a t c h f i r e s t o r e . r u l e s
+ 2 . ( H i g h ) D o c 0 7 �� � S t a t e C o n t e x t : u s e A u t h ( ) s i g n a t u r e d r i f t e d ; r e t u r n s h a p e m i s s i n g l o g o u t ( )
+ 3 . ( M e d i u m ) D o c 0 4 �� � D i r e c t o r y S t r u c t u r e : n e w ` s r c / h o o k s / ` n o t d o c u m e n t e d
+ 4 . ( L o w ) D o c 1 6 �� � G l o s s a r y : t e r m " s c o p e " u s e d i n c o d e b u t n o t d e f i n e d h e r e
+ ` ` `
+
+ T h e a g e n t * * d o e s n o t * * a p p l y t h e f i x e s . T h e u s e r r e v i e w s t h e r e p o r t a n d d e c i d e s w h a t t o a c t o n . O n c e a f i x i s a p p r o v e d , t h e a g e n t c a n e i t h e r r u n ` w i k i - b o o t s t r a p ` o n t h e a f f e c t e d s l o t ( r e - e l i c i t c o n t e n t f r o m s c r a t c h ) o r m a k e t a r g e t e d e d i t s p e r t h e u s e r ' s d i r e c t i o n .
+
+ - - -
+
+ # # 5 . L i f e c y c l e O p e r a t i o n s ( Y A M L & I n d e x S y n c i n g )
+
+ W h e n r e m e d i a t i n g a u d i t f i n d i n g s ( e i t h e r a s p a r t o f t h e a u d i t o r a s a f o l l o w - u p ) , a p p l y t h e s e r u l e s :
+
+ # # # A . P r o g r e s s i v e V e r s i o n C o n t r o l ( Y A M L )
+ E v e r y c r e a t e d o r m o d i f i e d f i l e m u s t u p d a t e i t s Y A M L f r o n t m a t t e r . M a r k s u p e r s e d e d d o c s w i t h ` s t a t u s : " d e p r e c a t e d " ` o r m o v e t h e m t o a ` d e p r e c a t e d / ` s u b f o l d e r .
+
+ # # # B . T a b l e o f C o n t e n t s S y n c i n g
+ W h e n a d d i n g o r d e l e t i n g f i l e s , u p d a t e t h e c o r r e s p o n d i n g c a t e g o r y i n d e x :
+
+ - ` . w i k i / f e a t u r e s / f e a t u r e s - i n d e x . m d `
+ - ` . w i k i / c o m p o n e n t s / c o m p o n e n t s - i n d e x . m d `
+ - ` . w i k i / d a t a b a s e / d a t a b a s e - i n d e x . m d `
+ - ` . w i k i / l o g i c / l o g i c - i n d e x . m d `
+ - ` . d e v o p s / b a c k l o g / b a c k l o g - i n d e x . m d ` ( o p e r a t i o n a l )
+
+ # # # C . P r o j e c t A u d i t L o g g i n g ( T h e W r a p - U p P r o t o c o l )
+ W h e n e v e r a n a u d i t i s c o m p l e t e o r a f i n d i n g i s r e m e d i a t e d , a p p e n d a c h r o n o l o g i c a l e n t r y t o ` . d e v o p s / l o g s / a g e n t - c h a n g e l o g . m d ` u s i n g t h i s e x a c t f o r m a t :
+
+ ` ` ` m a r k d o w n
+ # # [ Y Y Y Y - M M - D D H H : M M ] �� � < T a s k / F e a t u r e N a m e >
+ * * A g e n t : * * < A g e n t N a m e >
+ * * F i l e s M o d i f i e d : * *
+ - ` s r c / . . . `
+ - ` . w i k i / . . . `
+ * * D a t a b a s e C h a n g e s : * * N o n e ( o r l i s t m i g r a t i o n s )
+ * * S u m m a r y : * * < O n e - s e n t e n c e s u m m a r y >
+ ` ` `
+
+ - - -
+
+ # # 6 . Q u i c k T r i a g e P r e - S c a n ( O p t i o n a l , B e f o r e t h e L o o p )
+
+ B e f o r e w a l k i n g t h e 1 9 d o c s i n o r d e r , y o u m a y o p t i o n a l l y r e a d ` . d e v o p s / l o g s / a g e n t - c h a n g e l o g . m d ` t o s u r f a c e r e c e n t l y m o d i f i e d f e a t u r e s . U s e t h i s t o * * p r i o r i t i z e * * w h i c h s l o t s t o s c r u t i n i z e f i r s t �� � i t i s * * n o t * * a s u b s t i t u t e f o r t h e f u l l p e r - d o c l o o p . T h e f u l l w a l k i s a l w a y s r e q u i r e d r e g a r d l e s s o f w h a t t h e c h a n g e l o g r e v e a l s .
+
+ - - -
+
+ # # 7 . W h e n t o U s e T h i s S k i l l
+
+ - * * R o u t i n e a u d i t s * * �� � q u a r t e r l y , o r a f t e r a m a j o r f e a t u r e s h i p s .
+ - * * P r e - d e p l o y m e n t v i b e s c h e c k * * �� � p a i r e d w i t h ` p r e - d e p l o y m e n t - v i b e - a u d i t o r ` t o c a t c h d o c d r i f t b e f o r e i t s h i p s .
+ - * * S u s p e c t e d d r i f t * * �� � u s e r s a y s " t h e w i k i f e e l s s t a l e " o r " t h i s c o d e d o e s n ' t m a t c h w h a t t h e d o c s a y s . "
+ - * * O n b o a r d i n g a n e w p r o j e c t * * �� � w h e n h a n d e d a n u n f a m i l i a r c o d e b a s e , u s e t h i s t o s u r f a c e w h a t ' s k n o w n v s . w h a t ' s m i s s i n g b e f o r e m a k i n g c h a n g e s .
+
+ F o r b o o t s t r a p p i n g a n e w w i k i f r o m s c r a t c h , u s e t h e c o m p a n i o n s k i l l : * * ` w i k i - b o o t s t r a p ` * * .
+
+ - - -
+
+ > * * T h e G o l d e n R u l e * *
+ > I f a f e a t u r e ' s b e h a v i o r c h a n g e s i n c o d e , t h e d o c u m e n t a t i o n * * M U S T * * b e u p d a t e d i n t h e s a m e P R / C o n v e r s a t i o n . O u t d a t e d d o c u m e n t a t i o n i s t e c h n i c a l d e b t t h a t m i s l e a d s e v e r y A I a g e n t t h a t r e a d s i t n e x t .
+