BMG - Easy to use tool for quick Manual/ FAQ generation

BMG (Binary Manual Generator) is a manual generation tool which can be used to document a step-by-step guide/ manual for performing any task inside your projects, while also keeping the code and documentation at the same place. The final output is generated in HTML format which is easily viewable in any browser.

What this tool is NOT
BMG is NOT a documentation generation tool. I am pretty sure there are many tools doing that job perfectly.

We faced a problem
While working in teams, small or large, there is no easy way to transfer working knowledge of different modules inside a project. e.g. how to add a new tutorial, how to add a new menu or how to add a new skin for your character. Even an existing documentation does not solves this problem. Reason… A project MANUAL was missing.

And so BMG
We looked out on the internet to find an appropriate tool for our small problem and found many documentation tools but none of them solved our specific problem (Disclaimer: we are not saying that we have checked every tool in the world). And so we decided to create our own tool.

We created BMG with the main purpose to improve communication and knowledge transfer among team members while also increasing productivity of every individual.

Features

• Write documentation right next to your code, you won’t even have to leave Unity.
• Document FAQs and How To’s so that it is easier to transfer information to your team about how and why a specific task is done. (See ‘Example case study’)
• Steps for same FAQ can be distributed among separate scripts and on separate methods where they are more relevant. All these steps are automatically compiled to one place and in correct order in the final document
• XML style documentation syntax so that you won’t have to learn any new language.
• HTML template is included along with the project, completely built using bootstrap making it easily customizable to your taste.

Example Use Case Scenarios

A team member needs to add a new type of enemy to the game.

Without any manual or a how to guide the developer who actually implemented the system would have to personally explain other team members about how to add a new enemy to the system.
​

With BMG the developer can write a “FAQ” with all the steps explaining

• How to setup the model.
• What directory to put it in (in case there is a directory constraint).
• What scripts need to be associated to the model.
• What new scripts need to be created and what other script it needs inherit from.
• What place do you need to set the reference for the new enemy.

Benefits

• Without jumping to another tool, all these steps are written with in your script files in the form of comments.
• Steps for single FAQ/ Manual can be divided in different scripts and with different methods where they are more relevant. Also complementing the fact that the developer does not even have to switch back to same script to complete the guide.
• One does not need to jump to any external tool neither they need to switch back to the same script to compete the guide.

Download Link
https://assetstore.unity.com/packages/tools/utilities/binary-manual-generator-beta-116692

Demo Videos

Contact

• Email (unitytools@binexsolutions.com)
• Facebook (https://www.facebook.com/BinexSolutions/)
• Website (https://www.binexsolutions.com/)

NOTE: BMG is currently under development and we are running this release in closed beta and the displayed price is subject to change. If you wish to get a copy of the plugin please send us an email (mentioned above) and we will send you the package for free. Please do provide some feedback (critical, usefulness, ideas everything/ anything appreciated) once you have tried the plugin.
​