Lucy Docs is a VSCode extension designed to help developers create, maintain and integrate documentation for their projects. It provides a range of features to make it easier to create, manage, and export documentation, in alignment with code, and, all within Visual Studio Code. The key features of Lucy Docs, that set it apart from other Requirement Management tools are:
It is text-based, and lives inside VSCode. This allows it to be branched and merged with your code.
The Requirements are linked bi-directionally, meaning navigation is easy.
The Requirement can also link directly to the code, so the implementation or test of a requirement can be found immediately.
Traceability Matrices are auto-generated.
A number of export types and options are available for iteration during development, and sharing outside the project.
With Lucy, you can create documentation in a structured format, using Projects, Books, Chapters, Requirements and Blocks, and link your Requirements to your Code to maintain bi-directional traceability.
You can also export your documentation in various File Formats and Styles, including HTML and Markdown, and generate traceability matrices to visualize the relationships between your code and documentation.
Whether you're working on a small project or a large codebase, Lucy can help you keep your documentation organized and up-to-date, making it easier for you and your team to understand and maintain your codebase.
Lucy Docs is currently undergoing user testing & will be released to the public soon.
