Work Smart: Automate Documentation
Maestro is a complex product, having a modular structure. This means it consists of different elements, or modules, that can be set up and used altogether or one by one, if necessary. The majority of the tools are CLIs that need to have setup or quick start guides, reference guides, usage instructions and scenarios, etc. Each element needs to be documented separately, and the documentation needs to be maintained timely. This gives quite a big piece of work for either the development or documentation teams, or even both. However, Maestro team invented their own tooling for automating CLI documentation management, and this both significantly decreases the related daily effort, and facilitates keeping all deliverables to the same style and format, irrespective of the person who creates them. The custom documentation tool operates via a focused, repeatable pipeline: md → .docx → .pdf This process separates and integrates two content types: The static co...