Example of Software Manual

[Brian Catanzaro]

I write a lot of code to analyze data (typ. Matlab, Python, C++).  It is not meant for 'production' or distribution to a wide set of users.

I need to document the code with a manual so I and others can remember how to use the software.

Where can I find some examples of Confluence pages authored to document how to use software?

[Shannon S · Accepted solution]

Hi Brian,

We have a few examples below of Confluence sites used for technical documentation.

• 5 real-life examples of beautiful technical documentation

Here are also some public links where you can navigate various Confluence sites to get a better idea of how it's being used:

• Powered by Confluence

Lastly, I would recommend the following for documenting your code:

• Code Block Macro (included with Confluence)
• Various code macros from Marketplace

Let me know if you have any questions about this.

Regards,

Shannon

[Brian Catanzaro]

I took a quick look.  I didn't quite see what I'm after.  In some ways, I'm looking to go a few steps better than a "man page" and a few steps lower than a "Dummies book" or an "O'Reilly book".  I didn't quite see that in the examples.

I know the code block macro.  That's stylish.  I'm looking for clever ways to lay out the workflow and usage of a software tool.

[Shannon S]

Brian,

A few of our add-on vendors in Marketplace also use Confluence for their documentation. For example:

• ServiceRocket Documentation
• Bob Swift Documentation
• Adaptavist Documentation

I would recommend reviewing some of the other vendors as well but that should give you a good idea of how they use it.

Regards,

Shannon