Post History
I would definitely not recommend using Word for this. It is just not what it was designed to do. There are multiple documentation systems that have been developed specifically for the purpose of ...
Answer
#4: Attribution notice removed
by
System
·
2020-01-03T20:41:58Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/48175 License name: CC BY-SA 4.0 License URL: https://creativecommons.org/licenses/by-sa/4.0/
#3: Attribution notice added
by
System
·
2019-12-08T13:01:29Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/48175 License name: CC BY-SA 4.0 License URL: https://creativecommons.org/licenses/by-sa/4.0/
#2: Initial revision
by
System
·
2019-12-08T13:01:29Z (over 4 years ago)
I would definitely not recommend using Word for this. It is just not what it was designed to do. There are multiple documentation systems that have been developed specifically for the purpose of writing developer documentation. They provide frameworks and tools, and, what may be more important to you at this stage of the project, examples of what works. It is impossible to say which would be preferable for your particular project without knowing far more about it. But as a place to start I would suggest that you investigate [Sphinx](http://www.sphinx-doc.org/en/master/). Sphinx is the tool that was developed to document the python programming languages and the various libraries, modules, and platforms that are associated with it. It is widely used for similar projects. A lighter weight, and therefore less capable but simpler alternative is [Jekyll](https://jekyllrb.com/) which is also used for documenting many software products. It is a more generic model, so it won't give your as much help and guidance, but it is very straightforward to use and you could draw on the examples of many other organizations.
#1: Imported from external source
by
System
·
2019-09-24T17:41:18Z (over 4 years ago)
Original score: 6