skein

skein keeps requirements, specifications and their traceability as plain text in git. An item is a paragraph of a Markdown document, or a file of its own, with a stable ID, a type and typed links to other items. Code and tests cite the items they implement and check. skein reads all of it and answers the questions a project keeps asking: is everything consistent, what does this rest on, what is not tested yet, what changed, and what does the change reach.

There is no database and no server. Everything skein knows is in files you can read, review and merge like code.

%rule[lex.comment syntax final] A line comment starts with `//` and ends with the line.
It is not a %[lex.token].
$ skein check
skein: example: no problems (24 items of 2 types, 1 link types, 1 profiles, 31 citations)

Getting it

Each release has skein as one program for Linux, macOS and Windows, with nothing else to install. For VS Code there is the extension chasingdaylight.skein, which highlights markers and references in Markdown.

The documentation

Page What it covers
Writing items Markers, parts, item files, references in text, citations in code and tests.
Project files The .skein/ directory: configuration, item types, link types, profiles.
Commands check, trace, coverage, diff, impact, export, render, import, review, approve.
Reviewing Fingerprints, suspect links, reviews and approvals.
Importing Bringing in Doorstop documents and CSV files.
Design What skein is for, how it is built, and what is planned.
Requirements What skein is required to do, written in skein and checked by skein.

The requirements pages are produced by skein render from the same files that skein check checks, so they show what a rendered project looks like.

Status

skein is early and its version is 0.x: the file formats can still change. The core and the command line work and are tested on every platform. Rendering HTML by itself, test results, planning and the language server are planned; the design describes all of it.