Autodoc

Why Autodoc was made

Documentation is tedious, and because it doesn’t directly affect the functional quality of software, most people who write software don’t write good documents.  But for anyone who wants to develop high-quality software that can be used by a large community (i.e. Github), detailed documentation is crucial! Autodoc is unique in software development precisely because software developers are often reluctant, or generally unenthusiastic about, documenting code. We created Autodoc to bridge the gap between writing good software and writing good documentation.

How it Works

Autodoc boosts productivity and makes the documentation process completely painless by:

• Automatically documenting source code

• Conforming to documentation standards

• Understanding what software is doing

• Continuously self-improving

Created by developers, for developers, Autodoc automatically documents each function in Python, Java, and JavaScript, creating pull requests for merging changes (as if two programmers are working in tandem). And because Autodoc analyzes programs one function at a time, and generates a summary for each, you can instantly create a README document for an entire software repository! Autodoc basically acts as a virtual assistant, or co-pilot, automating the detailed, yet mundane, tasks associated with code documentation, so you can focus on coding.Plus, Autodoc actually understands software, and because it errs on the side of caution, it’s extremely reliable. With Autodoc, you can count on documentation efficiency, accuracy and coverage. Autodoc is completely free to use, and we hope it will help developers create better documentation as well as focus more time on coding.