← ClaudeAtlas

noyalib-docs-and-writinglisted

Maintain noyalib's docs of record and house writing style. Use when authoring or editing README, CHANGELOG, RELEASE-NOTES-vX.Y.Z.md, ADRs under doc/adr/, doc/POLICIES.md, doc/ARCHITECTURE.md, doc/USER-GUIDE.md, GLOSSARY.md, MIGRATION*.md, GETTING_STARTED.md, or crate-level and item-level rustdoc. Covers house rustdoc style (# Examples, # Errors, runnable doctests), commit-message archaeology (Assisted-by trailer, symptom/root-cause bodies), SPDX/REUSE headers per file type, ADR lifecycle (when required, template, post-implementation updates), release-notes template, and the version-refs release audit. Do NOT use for release mechanics (see noyalib-ci-and-release) or competitive positioning (see noyalib-external-positioning).
sebastienrousseau/agtmls · ★ 1 · AI & Automation · score 80
Install: claude install-skill sebastienrousseau/agtmls
<!-- SPDX-FileCopyrightText: 2026 Noyalib --> <!-- SPDX-License-Identifier: MIT OR Apache-2.0 --> # noyalib-docs-and-writing House style and process for noyalib's documentation of record. Repo is v0.0.14 (2026-07-07) on the `feat/v0.0.14` branch, on the 0.0.x runway toward v0.1.0. Skill date-stamp: **2026-07-08**. > **Reference material** (the verbatim per-file-type SPDX header > shapes, the full ADR process + skeleton, and the release-notes > template): see `reference.md` in this directory. This file keeps the > docs-of-record inventory, rustdoc / commit-message house style, the > writing rules, and the pre-PR self-check. ## Provenance checks Run before authoring to confirm shape hasn't drifted: ```sh head -20 CHANGELOG.md # Keep-a-Changelog shape ls doc/adr/ # ADR inventory + numbering ls RELEASE-NOTES-v*.md | tail -5 # release-notes cadence head -3 crates/noyalib/src/de.rs # .rs SPDX header shape head -2 RELEASE-NOTES-v0.0.14.md # .md SPDX header shape head -2 .github/workflows/shared-no-std.yml # .yml SPDX header shape git log -5 --format='%s%n%b%n---' # commit-body archaeology grep -n 'missing_docs' crates/noyalib/src/lib.rs ``` ## Docs of record — inventory Every claim in these files is load-bearing. Update in the same PR as the behaviour change, never as a follow-up. - **`README.md`** — public promises: install, quick start, capabilities, ecosystem, compar