Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

How do you structure your page trees for internal knowledge bases for processes or software?

I'm always curious how other people decide to design their knowledge base page trees. Ideally, it would make sense to both technical and non-technical viewers (even if they don't always all of the content like database schemes, etc).

For more complex projects we use something similar to this:

  • Team & Communication - This is an overview of the project
  • Development - different pages for test data, system architecture, new dev guides/resouces, dev/uat/stg/prod infrastructure, integration points, 3rd party components, etc.
  • Meeting Notes - internal/external meetings related to the project
  • Project Management - estimations, project plans, etc
  • Quality Assurance - overviews of qa environments, reports, testing plans, etc
  • Requirements - Technical requirements for the application; This is where most of the content lives. 
  • Retrospectives - mostly meeting notes from the dev team
  • Trackers - decisions, change requests, glossaries, dictionaires, external documents, scheduled tasks, etc.

For less complex projects we use something like this (adapted from this article):

  • 00 - About - General introduction and overview of the project, team and communications
  • 01 - Roadmap - All things related to planning and specifications. This is the main working area for the analysts and will contain things like backlogs, wishlists, functional specs for a future version etc. This is the main area where you will find the actual projects.
  • 02 - Development - Groups everything that someone needs to know to be able to develop on the application. Note that a technical analysis for a specific story to be implemented does not belong here, a technical overview of how something is implemented does.
  • 04 - Release Notes - This section gives an overview of the entire release history.
  • 05 - Maintenance & Support - This section groups all documentation relevant for operational (technical) support of the Knowledge Base. Ideally, this is enough so a team member without knowledge of the inner workings can offer basic support (like editing articles, check log files, etc).
  • 06 - User Documentation - Contains all end-user documentation like manuals or public API's.

Just curious how those more experienced handles this and I'm looking for ideas and best practices we should start following. 

0 comments

Comment

Log in or Sign up to comment
TAGS
Community showcase
Published in Confluence Cloud

🏠 Say hello to the new Confluence Home!

Hi Atlassian Community, My name is DJ Chung, and I’m a Product Manager on the Confluence Cloud team. Today, I’m excited to share a new and improved version of Home. The new Home helps you ...

39,240 views 28 126
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you