Skip to content

Comment on Ask HN: What is your personal motivation for documenting code?parent

Comments

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!

AboutSource Built by g1lg1l

Hackerly is an independent reader for Hacker News, built on the public HN API. Not affiliated with Y Combinator.