Noodle for Technical Writing
There are a lot of aspects to consider in technical writing. I’m interested in adapting noodle toward this purpose in some way.
I think it could be useful to have multiple views on a system:
- Version Control
- Access Control
- Sync
- Storage
- Standards Compliance
- Navigation Index
- Dependencies
The intersection of views and subsystem scope is what will be relevant to a particular audience.
IEEE compliant documentation for various industries contain many links to eachother and often contain redundant wording. This isn’t so much an issue for creating the documentation. The inefficiencies pop up when engineers have to work with the docs and make changes. Ordinarily you update the redundant docs and the underlying structure remains implicit. You need procedures for updating and syncronizing different versions of documents to ensure the information is accurate.
With a noodle you can directly represent the underlying structure. Then update the information in one place when needed. The whole structure can be managed under a global version control.
I’m hoping I can make a good example out of the noodle project itself. I’d like to get to a point where I have an underlying representation of the project with automated tooling to generate the docs, guides, and binaries.