Update the architecture plan to standardize on input -> chunk -> extract -> merge -> normalize -> output naming conventions
This commit is contained in:
@@ -11,7 +11,7 @@ not describe implemented behavior.
|
||||
Notarius documentation should make three boundaries obvious:
|
||||
|
||||
- source-format support belongs to input-stage modules;
|
||||
- extraction-domain behavior belongs to process-stage modules;
|
||||
- extraction-domain behavior belongs to extract-stage modules;
|
||||
- core framework behavior is source-agnostic and domain-agnostic.
|
||||
|
||||
Documentation should avoid making the MVP look more transcript-specific or
|
||||
@@ -47,7 +47,7 @@ Core docs should avoid transcript-specific terms such as segment, speaker,
|
||||
timestamp, and transcript range unless discussing an input adapter or an example.
|
||||
|
||||
Core docs should avoid D&D-specific terms such as spell, NPC, item, combat, and
|
||||
encounter unless discussing process modules, artifact docs, or examples.
|
||||
encounter unless discussing extract modules, artifact docs, or examples.
|
||||
|
||||
### Input Module Docs Own Source Formats
|
||||
|
||||
@@ -95,12 +95,12 @@ Stage module docs should cover:
|
||||
- prompt and response-schema ownership;
|
||||
- examples.
|
||||
|
||||
D&D concepts should be documented in D&D process-module or artifact docs, not in
|
||||
D&D concepts should be documented in D&D extract-module or artifact docs, not in
|
||||
generic runner or framework docs.
|
||||
|
||||
### CLI Docs Should Reflect Extensibility
|
||||
|
||||
The CLI reference should present input modules, chunk modules, process modules,
|
||||
The CLI reference should present input modules, chunk modules, extract modules,
|
||||
merge modules, normalize modules, and output modules as selectable or
|
||||
configurable components as they become user-facing.
|
||||
|
||||
@@ -114,7 +114,7 @@ Once implemented, `docs/cli.md` should document:
|
||||
|
||||
- positional source input path;
|
||||
- input module selection;
|
||||
- process module selection;
|
||||
- extract module selection;
|
||||
- chunk/merge/normalize/output selection when configurable;
|
||||
- config path behavior;
|
||||
- output path behavior;
|
||||
@@ -127,7 +127,7 @@ Once implemented, `docs/cli.md` should document:
|
||||
|
||||
- input module selection and module-specific options;
|
||||
- chunk module selection and module-specific options;
|
||||
- process module selection and module-specific options;
|
||||
- extract module selection and module-specific options;
|
||||
- merge module selection and module-specific options;
|
||||
- normalize module selection and module-specific options;
|
||||
- output module selection and module-specific options;
|
||||
@@ -176,7 +176,7 @@ Before merging docs, check:
|
||||
|
||||
- Does the document describe implemented behavior outside `docs/roadmap/`?
|
||||
- Are source-format details isolated to input module or integration docs?
|
||||
- Are D&D details isolated to process module or artifact docs?
|
||||
- Are D&D details isolated to extract module or artifact docs?
|
||||
- Is there one canonical home for the topic?
|
||||
- Do command examples match implemented CLI syntax?
|
||||
- Are examples valid, maintained, and free of secrets?
|
||||
|
||||
Reference in New Issue
Block a user