davideandClaude Sonnet 5.5
ccfa00ff52
Nuovi doc: tutorial-primo-giro, risoluzione-problemi, sviluppo, rilascio, glossario e registro delle decisioni (docs/decisioni, 6 ADR). docs/README.md e' l'indice per categoria e la tabella delle fonti uniche; il README di root rimanda a sviluppo/rilascio invece di duplicarli. scripts/CheckDocs.cs verifica link e ancore, <Version> contro CHANGELOG, copertura di architettura.md e presenza di ogni doc nell'indice; .markdownlint-cli2.jsonc configura il lint Markdown. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2.4 KiB
2.4 KiB
Documentazione di PrepStep
Indice dei doc, organizzati secondo Diátaxis: ogni file ha uno scopo, e cambia solo quando cambia il programma.
Tutorial — imparare facendo
tutorial-primo-giro.md— il primo giro completo con una distinta vera.
How-to — svolgere un compito
guida-utente.md— i passi dell'utente fino a Creo Distributed Batch.risoluzione-problemi.md— sintomo → causa → cosa fare.sviluppo.md— build, test, script e regole per scrivere i doc.rilascio.md— pubblicare e generare il setup di una nuova versione.
Reference — consultare
architettura.md— il processo delle 5 fasi e la mappa file-per-file.db-cad-index.md— schema, vista e query dicad_index.db.formato-asm-record.md— parser esatto dei record.asm, casi limite (§7).formato-asm.md— euristica testuale di fallback.glossario.md— i termini usati nei doc e nell'app.../CHANGELOG.md— storico delle versioni.
Explanation — capire il perché
decisioni/— registro delle scelte di progetto (ADR).copia-raw-parallela.md— perché e come la copia inraw/è parallela.
Fonte unica (SSOT)
Ogni informazione vive in un posto; altrove si mette un link, non una copia.
| Informazione | Fonte |
|---|---|
| Versione e nome prodotto | PrepStep/PrepStep.csproj (<Version>, <Product>) |
| Schema e vista del DB | db-cad-index.md |
Formato dei record .asm e casi limite |
formato-asm-record.md |
| Processo delle 5 fasi, mappa dei file | architettura.md |
| Passi dell'utente | guida-utente.md |
| Build, test, regole sui doc | sviluppo.md |
| Procedura di rilascio e setup | rilascio.md |
| Perché una scelta è fatta così | decisioni/ |
| Storico release | ../CHANGELOG.md |
CLAUDE.md e README.md riassumono soltanto e rimandano a questi file.
Verifica
dotnet run scripts/CheckDocs.cs
npx markdownlint-cli2