artifact: the design doc tool made for developers

See the Wiki for the User Guide and other information.

Use the Issue Tracker if you find any bugs or have major questions.

Installation and Tutorial

See the User Guide on the wiki.

Beta Notice

artifact is still in Beta and is not 100% feature complete. The API for the cmdline and text format is expected to be stable, but the author reserves the right to change anything that needs to be changed if it improves usability.

Future improvements include:

• Additional command line tools
  • export: export artifacts to json, csv, html and other formats
• Test Tracking: REST API with DB backend for tracking test execution
  • plus cmdline utility and webui for viewing test execution. (artifact currently only supports tracking implementaiton, not execution)
• The Web UI is currently read-only. It will be able to edit soon.

Licensing

The artifact file format (the format of the toml files, artifact name, etc) is licensed under the CC0 (Creative Commons Public Domain) License. Any person can use the format for any reason without the need for even attribution (attribution is appreciated though!)

The artifact library and web-ui are licensed under the LGPLv3+, except for files which say otherwise in their header. See LICENSE.txt for more information.