SuperAPI AI Directory

aisdlc-project-discover-level1-index-skeleton

Coding & development

View repository

Updated 10-16 08:49

About this skill

aisdlc-project-discover-level1-index-skeleton (Step3: index skeleton + progress panel)

Overview

The sole responsibility of the index page is:navigation + progress. All details belong on module pages/contract entry pages/ops pages.

At the start, announce:"I am using the aisdlc-project-discover-level1-index-skeleton skill to generate the map-layer index skeleton and checkbox progress panel."

Output files (skeleton)

  • .aisdlc/project/components/index.md
  • .aisdlc/project/products/index.md(optional)
  • .aisdlc/project/contracts/index.md
  • .aisdlc/project/contracts/api/index.md
  • .aisdlc/project/contracts/data/index.md

Writing constraints (hard rules)

  • index.md Navigation only: table + links + status checkboxes; copying module details is forbidden.
  • Use checkboxes to manage completion progress:
    • - [ ] moduleA: not yet met
    • - [x] moduleA: meets the corresponding priority DoD

Minimal template (copyable)

components/index.md

module priority owner code_entry api_contract data_contract ops_entry status
P0/P1/P2 <path> ../contracts/api/<module>.md ../contracts/data/<module>.md ../ops/... - [ ]

contracts/index.md

  • API:./api/index.md
  • Data:./data/index.md

contracts/api/index.md

module authority_entry invariants evidence status
<openapi/proto path> 3-7 summary items code/test/ci entry points - [ ]

contracts/data/index.md

module ownership authority_entry invariants evidence status
primary-write/read-only/sync <schema/migrations path> 3-7 summary items code/test/ci entry points - [ ]

products/index.md(optional)

product_module owner key_components key_data_ownership status
../components/... ../contracts/data/... - [ ]

Common mistakes

  • Writing the index as a module page: it grows longer and longer, causing maintenance explosion; only links and very short summaries should be kept.
  • No checkbox progress: you will lose the iterative mechanism of "skeleton first, evidence later".

Red-flag checklist (if any appears: stop and correct)

  • Interface field descriptions/table field dictionaries/detailed sequences/operation manuals appear in the index
  • Copying module page content into the index just to "look complete"
  • Starting to write a large amount of module detail without clarifying P0/P1/P2