Development Documentation
Tools Used: Atlassian Confluence & Jira
Expected Audience: Internal Software Developers, Product Owners, and UX Team
The following is an example of Internal Design Documentation that I created using Atlassian’s Confluence and Jira. I gained a lot of valuable experience working with Confluence and Jira and with the help of a technical product owner I learned some helpful ways to connect the two platforms.
This document allows you to automatically generate User Stories in Jira to better synergize product owners and software development teams by passing table information from this Confluence page to Jira and halving the work needed to be done!
This specifies how the Guest Notes feature should work for a hypothetical business, and denotes user needs, application views, further application connections to other features, design requirements, user stories, and the data fields used by this feature.
I also list the microcopy intended to be used in the application as denoted by the “Field” column in the Data Table.
Improvement Opportunities
This document would benefit from adding version tabs and tags at the top, denoting which version of the product the document applies.
Links to prototypes created by the UX team could also be added for easy viewing, and tooltip text could also be included in the Data Table section for possible tooltips added to the application.