Upgrade Instructions
xDoc, the best way to document your projects in Unity!
Website |
Tutorials |
Forum |
Manual
xDoc is designed to be a documentation system:
- content data,
- meta data,
- browse,
- search and
- bulk operations!
With xDoc you get embedded documentation in the Unity editor.
Don’t confuse this with just leaving single comments here and there.
The important part is to be able to find and access the information you need, when you need it.
This means you have to be able to browse and search your documentation.
In the best case your content is also classified with meta-data,
which you then can use to browse and search more efficiently.
How do I create my documentation?
You build your documentation by adding annotation components to GameObjects. They contain the content and the meta data and you can adapt their look and feel to your taste and needs: Unobtrusive and inconspicuous or standing out and prominent.
You can further customize annotations to be shown in the Inspector, the Hierarchy View or the Scene View.
How do I access my documentation?
You can browse your annotations in the hierarchy view or in the bulk operations screen.
The hierarchy view can show icons and text fields, which have popups with the full annotation text.
Or you can search your documentation with the powerful, web-like search engine.
And how do I share my documentation?
You can distribute your documentation with the included free reader.
Maintain a well documented project and boost your productivity with xDoc!
