The documentation management tool that re-defines how and when you can interact with your comments. Providing an intuitive and easy to use system for individual developers and large development teams.
CrossDoc is a command line tool and text-editor plugin that allows you to decouple your comments from your code. This improved modularity means that CrossDoc can provide unique commenting features previously impossible such as comment classification and support for external comment manipulation. In short, CrossDoc is a documentation tool that greatly improves the workflow of developers and teams.
The CrossDoc system also provides intuitive text editor plugins for Atom, Emacs, Sublime, and Vim. These editors allow you to seamlessly interact with CrossDoc comments through your favorite editor, greatly expanding how and when you interact with your documentation.
Comment classification, or comment sets, is the grouping of similar comments so that developers can toggle through distinct comment sets. For example, a team may have a group of comments classified as Newbie Notes that includes verbose comments describing all aspects of the functions it encompasses. An experienced developer may be more interested in the classification labeled Design Rationale that includes comments describing why a function works as it does, rather than how.
Comment Classification Example
By creating and supporting the use of an external wiki storage method, CrossDoc extends commenting beyond simply being accessible adjacent to the code it describes. Now, with CrossDoc, comments can be created, viewed, edited, and deleted on an external wiki that the team hosts on their intranet. This feature does not replace the existance of comments in the codebase, it simply expands the capabilities.
External Comment Example
An in-depth analysis of CrossDoc, and the product it aims to be, is available on the documents page. Here you can find the most recent copy of our requirements document alongside other project and team documents.