In large personal projects I try to be thorough in my documentation and naming conventions it helps me to write more durable software. When I am on my own time I prefer to keep my software as durable as possible because I am not being paid a salary to qualify all the extra time spent on regression, defects, and reviewing prior decisions. I would rather spend this personal time on design decisions instead, and central to the corresponding planning processes is well written documentation. It also helps when the documentation is itself interactive.
Could you share any examples of interactive documentation or tools to build interactive documentations? The only thing comes to my mind is Swagger / OpenAPI documentation pages from Spring that allows you to send the request.
* A terminal command just for displaying documentation on all other supported terminal commands by the application. Then more detailed documentation for each specific command with examples. Finally, a validation engine that allows per character validation of terminal input, as in a REPL.
* Similar input characteristics for a web-based interface.
* Documentation search function and/or auto-complete
Comments
In large personal projects I try to be thorough in my documentation and naming conventions it helps me to write more durable software. When I am on my own time I prefer to keep my software as durable as possible because I am not being paid a salary to qualify all the extra time spent on regression, defects, and reviewing prior decisions. I would rather spend this personal time on design decisions instead, and central to the corresponding planning processes is well written documentation. It also helps when the documentation is itself interactive.
Could you share any examples of interactive documentation or tools to build interactive documentations? The only thing comes to my mind is Swagger / OpenAPI documentation pages from Spring that allows you to send the request.
* A terminal command just for displaying documentation on all other supported terminal commands by the application. Then more detailed documentation for each specific command with examples. Finally, a validation engine that allows per character validation of terminal input, as in a REPL.
* Similar input characteristics for a web-based interface.
* Documentation search function and/or auto-complete
Thank you!