unilop.blogg.se

1. #HOW TO USE CONFLUENCE FOR DOCUMENTATION MANUALS#
2. #HOW TO USE CONFLUENCE FOR DOCUMENTATION PDF#
3. #HOW TO USE CONFLUENCE FOR DOCUMENTATION MANUAL#

This is the knowledge base of your project: It is a picture of the current state of the documentation.Ītlassian already has integrations between the two products: One should however notice that an issue doesn’t give an overview of a project, unless you live in a flat world with only one dimension.ĭocuments resulting of activities such as early analysis, requirement gathering, design and customer interviews should be kept in Confluence. The reason why we’d advise to keep all “change management” in JIRA is because you want to track all sprints, features, bug reports and requests of any kind with an “issue number.” They help track the origin, stakeholders, estimates and discussions about every change. While JIRA is ideal for tasks, Confluence is better at capturing text and content. Today we’re going to look at managing business and functional requirements and technical specifications in Confluence. Its ergonomics and perks, such as macros, document organization and teamwork features, bring up new ways of organizing your teams, but this has already been discussed in a previous article (“ The myth of the shared network drive” in French). We are kind of missing the ability to expose the content through a simple and customized portal - Equivalent to JIRA exposed to the support product at Atlassian.įor now, we have moved forward with Intercom (intercom.io), where the ability to expose documentation focuses on the document/content, and not all the visual clutter - it is a really calm down-toned user experience.Atlassian Confluence is a mind-blowing tool for capturing information on a project. I am aware of other solutions, including custom coding and accessing the content over API, where you get an highly customized experience, which is the point - not all want to go down that road. Menus are rendered for users to interact, as if they were maintaining the documentation.

When receiving a document, the user is not only presented of the content of the document, but all the visual aids, that goes with confluence, such as navigation etc. My experience is that confluence (cloud) has its strengths elsewhere than exposing documentation in a public domain, as where internet users can access how-to-documents or other knowledge-base documents. This is certainly the Atlassian approach so they have a vested interest in improving the tool. If you intend to just provide users anonymous access to your Confluence site then a lot of these issues won't be a problem for you I guess. In fact that's one of our biggest issues, finding stuff in Confluence.

#HOW TO USE CONFLUENCE FOR DOCUMENTATION MANUALS#

I'm sure there are better documentation tools out there that produce first class manuals and online docs and have a decent, structured search mechansim. If I were doing it all over again, I would probably not use Confluence at all, it's just too limitiing and cumbersome.

We end up with something pretty decent and coupled with the context sensitive aspect, it fits our needs but it is far from perfect. The Confluence API isn't that easy to follow, the extracted HTML needs a LOT of cleanup and the page hierarchy is very difficult to replicate. This all sounds like a shed load of work and you would be right!

#HOW TO USE CONFLUENCE FOR DOCUMENTATION PDF#

The document builder also creates a full PDF of the each manual. Each space is exported to a single, static HTML package (all the pages, images and CSS) as part of the build process using the Confluence API. The Confluence content is also the context sensitive help and we achieve that by adding in 'special' tags into the Confluence content that we want to be linked to a web location in SMARTset.

#HOW TO USE CONFLUENCE FOR DOCUMENTATION MANUAL#

We have a space for each manual and an extra space where we store all our shared excerpts (we use the Multiexcerpt Macros plugin). We use Confluence to author the user documentation for our product SMARTset at 4NG.