Audion DocFlow - Project Files Guide
This is the English companion to PROJECT_FILES_GUIDE_RU.md.
Project Scope
Audion DocFlow is a portable, offline-friendly toolkit for deterministic DOCX, XLSX, CSV, and Markdown cleanup, compliance gates, table helpers, comparisons, and reports.
The current main-kit scope is not OCR. OCR and AI-assisted OCR flows belong in a dedicated project.
Project Root
launcher_gui.cmd- GUI shell over the existing CLI/FZF commands.launcher_project.cmdandlauncher_project_ru.cmd- user project workflows.launcher_tools.cmdandbuilder_main.cmd- service/build/release tools.cleanup_project.cmd- managed cleanup for generated project artifacts.README.mdandREADME_RU.md- project overview.AGENTS.md- maintenance and architecture rules.
Launcher And GUI
The GUI stages files into input\, writes results to output\, and keeps live logs visible. Service and release operations stay in service launchers rather than the first GUI screen.
Main GUI areas include:
- DOCX quality checks and finalize/gate workflows;
- find/replace and morphological replacement;
- rules audit and anchor approval;
- a
Styles and hygieneworkbench withTEXT HYGIENE, `DOCUMENT
ANOMALIES, and DOCUMENT STYLES` tabs, scan/fix modes, responsive checkbox groups, and the run button in the top command row;
- deep DOCX hygiene, which orchestrates text hygiene, deterministic audit
rules, and optional document anomaly scan/correction into one report;
- Word/Excel table operations, including the root
Unify tables in document
command for one-pass table normalization inside existing DOCX files;
- compare and reconcile operations;
- technical Markdown/XLSX helpers.
GitHub Folder
GitHub\ contains repository-facing README files, release text, one-liners, project descriptions, license text, and this project file map.
Install Folder
install\ contains build, portable runtime, folder initialization, dependency, and release helpers. Use it for rebuild/release work, not as the daily user surface.
System Core
system_core\ contains the deterministic document engines, CLI entry points, GUI services, Word/Excel helpers, report writers, and shared project utilities.
Important categories:
- DOCX checks, finalize, comments/tracked-changes cleanup;
- text hygiene, deep hygiene, document anomaly scan/correction, and
conservative nonprinting-garbage cleanup;
- rules audit and annotated DOCX flows;
- DOCX/XLSX/CSV table helpers, table stitching, table unification, document
table normalization, width fitting, and extraction;
- compare, reconcile, similarity, and Word COM operations;
- GUI service functions and manifest-driven operation wiring.
Config And Rules
Configuration stores GUI settings, operation manifests, audit rules, and deterministic workflow settings. Do not change config files while only updating documentation.
Tests And Smoke
Use the documented smoke and py_compile checks before packaging or after changing engines. Reports and diagnostics should be reviewed from report\ and logs\.
Practical Reading Order
- Read
README.md. - Read the GUI/user workflow sections.
- Read
GitHub\PROJECT_FILES_GUIDE_RU.mdor this English companion for structure. - Use
docs\notes for specialized Codex/document workflows.