| |
 |
| Paper: |
The Documentation Developer Experience: Documentation Engineering at the Vera C. Rubin Observatory |
| Volume: |
541, ADASS XXXIII |
| Page: |
151 |
| Authors: |
Jonathan Sick; Frossie Economou |
| DOI: |
10.26624/XWGH8202 |
| Abstract: |
At Rubin Data Management, we set out early in construction to create a
healthy documentation culture, aided by a platform that values low-friction documentation creation and guaranteed-accurate documentation techniques. The basis is docs-like-code, with a versioned documentation hosting system that deploys documentation
as a regular practice of merging, tagging, and making pull requests in a Git repository. An automated templating enables anyone to quickly start up a new documentation
project. Documentation configuration and generation packages absorb complexity from
authors. A documentation hub updates automatically when content is pushed, and is automatically curated on the basis of metadata published by each project. This approach
extends beyond code documentation, with a technical note system that enables developers to communicate efficiently across teams and the astronomy community. |
|
|
|
|
|
