ZDDC
ea385b5366
ZDDC — Zero Day Document Control. A file-naming convention plus five single-file HTML tools (archive, transmittal, classifier, mdedit, landing) and an optional Go HTTP server (zddc-server) with ACL and a virtual archive index. Self-contained, offline-capable, dependency-free. See README.md for an overview, AGENTS.md and ARCHITECTURE.md for the build/release/architecture detail, bootstrap/README.md for the two-level deployment install pattern, and zddc/README.md for the HTTP server.
55 lines
3.6 KiB
Markdown
55 lines
3.6 KiB
Markdown
# Zero Day Document Control (ZDDC)
|
|
|
|
**The Universal Distributed Filing Cabinet**
|
|
|
|
ZDDC is an information management convention plus a small set of single-file HTML tools. Every deliverable's filename encodes its tracking number, revision, status, and title; every transmittal folder is date-prefixed and self-describing. A plain shared folder becomes a fully searchable, auditable archive — no server, no database, no software required to read it.
|
|
|
|
The name "Zero Day Document Control" comes from the convention itself — adopt it on day zero of a project, with no setup time. The tools are *optional* interfaces around the structure; the structure works without them.
|
|
|
|
> **For end users**: <https://zddc.varasys.io/> introduces the project, links to all tool channels (stable / beta / alpha), and offers `install.zip` for self-hosted deployments.
|
|
|
|
## Tools
|
|
|
|
| Tool | What it does |
|
|
|------|--------------|
|
|
| **[Archive Browser](https://zddc.varasys.io/releases/archive_latest.html)** | Browse, search, and filter a project archive folder. Group by transmittal, export selections as ZIP. |
|
|
| **[Transmittal Creator](https://zddc.varasys.io/releases/transmittal_latest.html)** | Self-contained HTML transmittal records with SHA-256 checksums and optional digital signatures. |
|
|
| **[Document Classifier](https://zddc.varasys.io/releases/classifier_latest.html)** | Spreadsheet-like bulk-renamer that copy/pastes with Excel and writes back to disk. |
|
|
| **[Markdown Editor](https://zddc.varasys.io/releases/mdedit_latest.html)** | Browser-based markdown editor with YAML front matter, TOC, and direct local file access. |
|
|
|
|
Each tool is published in three channels (stable, beta, alpha) at `https://zddc.varasys.io/releases/<tool>_<channel>.html`. Append `?v=alpha` (or `?v=0.0.4`, etc.) to any URL to switch versions for one request. See [`bootstrap/README.md`](bootstrap/README.md) for the install / pin / audit story.
|
|
|
|
## File-naming convention
|
|
|
|
The full specification — filename format, tracking numbers, revision rules, status codes, folder naming, and the transmittal workflow — lives at <https://zddc.varasys.io/reference.html>.
|
|
|
|
Quick example: `123456-EL-SPC-2623_A (IFR) - Specification For Switchgear.pdf`
|
|
|
|
## Build & develop
|
|
|
|
```bash
|
|
git clone https://codeberg.org/VARASYS/ZDDC.git && cd ZDDC
|
|
|
|
sh build.sh # build all tools (writes to dist/ only)
|
|
sh archive/build.sh # build one tool
|
|
|
|
sh archive/build.sh --release # cut stable; auto-bumps patch from last tag
|
|
sh archive/build.sh --release 0.1.0 # explicit version
|
|
sh archive/build.sh --release alpha # cut alpha (mutable channel, no tag)
|
|
sh archive/build.sh --release beta # cut beta
|
|
|
|
npm install && npx playwright install chromium && npm test # tests
|
|
./dev-server start # cache-busting HTTP on :8000
|
|
```
|
|
|
|
Authoritative build/release docs are in [`AGENTS.md`](AGENTS.md). Architecture notes (single-file rationale, JS module pattern, security model) are in [`ARCHITECTURE.md`](ARCHITECTURE.md). zddc-server (optional Go HTTP server with ACL and a virtual archive index) is in [`zddc/README.md`](zddc/README.md).
|
|
|
|
## Contributing
|
|
|
|
ZDDC is an open source project hosted on Codeberg at <https://codeberg.org/VARASYS/ZDDC>. Bug reports, feature requests, and pull requests welcome.
|
|
|
|
ZDDC is designed for zero configuration to start and minimal configuration overall — feature proposals are filtered through that lens.
|
|
|
|
## License
|
|
|
|
[GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html). Free to use, modify, and distribute, including commercially, under the terms of the license. Provided "as is" without warranty.
|