Overview

This article outlines the process for drafting, reviewing, and publishing Confluence pages within our organization. The goal is to ensure that all documentation is consistent, accurate, and meets our internal standards before being made publicly available.

Purpose

The purpose of this process is to streamline the creation and approval of Confluence pages, maintain high-quality documentation, and facilitate effective collaboration and review. By following these steps, you can ensure that your Confluence articles are properly vetted, approved, and published efficiently.

Process

1. Create a Ticket

   • Open a new ticket in your project management system (e.g., Jira).

   • Provide a clear title and description for the article.

   • Attach any initial drafts or notes related to the article.

2. Draft the Article

   • Recommended: Draft the article directly in Confluence.

   • *Alternatively, you can draft the article in Word.

3. Assign to Manager for Approval

   • Once the draft is complete, attach the document to the ticket or link to the Confluence draft page.

   • Assign the ticket to your manager for review and approval.

4. Peer Review (Recommended)

   • Before submitting the draft for manager approval, seek peer review to ensure accuracy and clarity.

   • Make any necessary revisions based on feedback.

5. Submit for Manager Approval

   • Ensure the article follows the guidelines:

     • Use bullet points for non-sequenced lists.

     • Use numeric lists for step-by-step instructions.

     • Ensure the article is easy to read and follows the recommended format.

   • Confirm that the article uses the provided template if recommended.

   • Comment on the Confluence page to request submission.

6. Manager Approval

   • Wait for the manager to review and approve the article.

   • If revisions are needed, make the necessary changes and resubmit for approval.

7. Publish the Article

   • Once approved, publish the article in Confluence.

   • Close the ticket under your name to indicate completion.

8. * Documentation Management (If Drafted in Word)

   • In Progress: Store drafts and work-in-progress documents in In Progress.

   • Ready for Review: Store documents awaiting review in Ready for Review.

   • Ready for Confluence: Store approved documents ready for Confluence publication in Ready for Confluence.

9. Additional Tips

   • Always use the recommended Confluence template when creating new articles.

   • Ensure clarity and conciseness in your writing to improve readability.

   • Follow any specific formatting or style guidelines provided.