nc_program_manager/.paul/phases/12-docs-cli/12-01-SUMMARY.md
dtrentin f55d0b313b docs(12-docs-cli): complete CLI reference in README — all 16 args + 12 error codes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-18 22:37:58 +02:00

2.2 KiB
Raw Blame History

phase plan subsystem tags requires provides tech-stack key-files key-decisions duration started completed
12-docs-cli 01 docs
readme
cli
documentation
README.md params table — 16 CLI args with Italian descriptions
README.md codici errore section — 12 error codes with causa + soluzione
added patterns
created modified
README.md
Error codes table expanded to 4 columns: codice, descrizione, causa probabile, soluzione — operator needs actionable guidance not just a label
16 params total (plan said 15 — recount found -help was the 16th)
~20min 2026-05-18T00:00:00Z 2026-05-18T00:00:00Z

Phase 12 Plan 01: README complete CLI reference

Expanded README.md params table from 6 → 16 entries; added 12-row error codes table with causa probabile and soluzione.

Performance

Metric Value
Duration ~20min
Tasks 2 completed
Files modified 1

Acceptance Criteria Results

Criterion Status Notes
AC-1: Params table has all entries Pass 16 rows (plan counted 15 — -help was 16th)
AC-2: Every arg in MostraAiuto() present Pass Cross-checked Program.cs lines 305336
AC-3: Error codes section lists all 12 codes Pass Cross-checked Program.cs lines 278289, 339350
AC-4: All text Italian, operator-facing Pass Read-through confirmed
AC-5: Existing content unchanged Pass Diff verified — only additions

Files Created/Modified

File Change Purpose
README.md Modified Params table 6→16 rows; error codes section added with 4 columns

Decisions Made

Decision Rationale Impact
4-column error table Operators need cause + fix, not just a label Better troubleshooting without calling vendor
16 params (not 15) Recount: -help is a distinct param, plan undercounted by 1 No impact — all params documented

Deviations from Plan

Plan said 15 params — actual count is 16 (-help counted separately from flags). All 16 documented.

Next Phase Readiness

v0.3 milestone complete. No further phases planned.


Phase: 12-docs-cli, Plan: 01 Completed: 2026-05-18