Learn how to delete a template from your space. All of these companies have chosen to use Confluence as their home for online technical documentation that also lives online. Whenever you're on a page in your documentation space, choose theWatchbutton at the top-right of the page. Choose principles that are concrete, that reflect your organizations unique point of view, and that designers can apply using their expert discretion to resolve any tensions or conflicts. Here are a couple of companies that publish their Confluence-written tech docs online. We've got a template that's a perfect fit for your project. Technical documentation is too valuable to ignore or put off, but it can seem tedious to create when youre also focused on development tasks. A runbook has clear, step-by-step instructions, enabling anyone to understand the core concepts of the system or application, regardless of their level of familiarity. Our process encourages technical writers to add not just image but video content in Confluence, providing users with a rich choice in how they want to consume the published information. I've added an anchor at the top of this page so you can click to go back to the top. Confluence is a flexible platform with a range of features and Marketplace apps that can help you capture, distribute, and update your technical documentation. If you use Confluence/wiki or any other tool, put the documentation there. Check out three standard technical docs that your team can create in Confluence: 1. Challenges come and go, but your rewards stay with you. Atlassian is an enterprise software company that develops products for software developers, project managers, and content management. And with fast-moving development teams and product release cycles, it can be a challenge to keep your documentation up-to-date, accessible, and looking professional. Learn more How do I duplicate a Slite template? Install global blueprints from the Atlassian Marketplace, Enable and disable blueprints for the space they manage, Edit blueprints to customize them for their space, Promote and unpromote blueprints within their space. These attributes also apply when viewing their documentation on a mobile device (three cheers for responsive design). This theme was removed inConfluence 6.0. Confluence has an article,https://confluence.atlassian.com/doc/develop-technical-documentation-in-confluence-226166494.html on how to develop a generic technical document, but it doesn't actually have a real template for a technical specification document. Utilize the product condition template to flesh out that assumptions you're making, student stories, UX design, scoping, and more. The pages will be picked up by other searches though, as they're normalConfluence pages. The model browser (and Importance tab) will disappear as soon as you start typing. Description of the Problem. On a public site, you might restrict viewing to staff members, so that the general public can't see the page. There are a lot of great templates included with Confluence, so check those out. Below are some tips to help you get your technical documentation site started, and to save you time and effort managing your documentation's life cycle. Learn how to create great content and organize it. Confluence: A Brief Overview | Atlassian Learn how to create great content and organize it. Keep earning points to reach the top of the leaderboard. Technology leader with a vision and strategy on a mission to help your organisation become a truly data-driven organisation. Create as many versions of your documentation as you like, make the changes you need to, and keep them up your sleeve until release time. Adding a document browser to your app is one way to do this., You can use technical documentation tools to collaborate on technical documentation and organize your content:, With a strategic approach to technical documentation and the right tools, you can learn how to write technical documentation that is both effective and easier to create. To view page history, go to the page and choose>Page History. If we attach the image to every page, there might be 50 pages we need to update when things change; if we use anInclude Page macro, we update once and it's changed everywhere. Where necessary, your template should include guidance on how to use and adapt it and any conventions you want to maintain. With Confluence, teams can create pages for everything from meeting notes and project plans to product requirements and technical documentation. usually business, financial or technical contacts. Its the perfect starting point for any design system. If thats not enough, youll find more templates on the Atlassian Marketplace, and you can even create your own. 5 real-life examples of beautiful technical documentation A loose description of this workflow is 'draft, review, publish'. The best part is, you don't need to do anything except add the macro; once you've added it, it'll automatically detect headings and add them to the table of contents. Place each release notes intro in anExcerpt macro, then add anExcerpt Include macrofor each set of release notes to the what's new page.
