How to use Confluence to document functionality of an existing product?

David Lines

Hi All,

My company recently started using Jira/Confluence and I would like to use Confluence to document the functionality of an existing product. I would like to do this so our QA team can create a test plan, but also so the existing functionality is captured somewhere. If possible I'd like this to be an extensible document so that it can grow as the product grows. I don't need to link to stories in Jira (yet) since the product is already built. But I will when the product grows and changes.

Any suggestions?

Thanks in advance for your help.

-Dave

Ismael Jimoh

Hi David,

From my experience we do the following:

1. A short summary of what the project is about
2. List out who are the stakeholders.
3. A more detailed description of what the project is about and justification of various decisions.
4. Add a screenshot of the workflow so people can refer to it for easy understanding of the business process.
5. List your schemes(optional but it is useful when you have a large JIRA instance with lots of shared schemes).
6. List any custom functions that happen in your project or issue's life-cyle or business process.

You could create a confluence blueprint based on the above to use for documenting each of your projects and in future, users just need to select this blueprint when documenting a new project rather than worrying about how to document new projects.

Hope it helps.