Nathan Wailes - Blog - GitHub - LinkedIn - Patreon - Reddit - Stack Overflow - Twitter - YouTube

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Table of contents

Child pages

Related pages

Tasks

  • Create a bookmarklet and a keyboard shortcut where I can press some keyboard combination and have copied to my clipboard linked text, where the URL is the current page and the text is in the format 'YYYY.MM.DD - Domain.TLD - Title of Page'

Best practices for using a Confluence wiki

Naming pages

  • If users will be often reading the page name in the child page / sidebar list, it may be a good idea to name the page with the specific designation first and the general designation second (e.g. if the parent page is named "Mobile", then the child page should be named "Development Frameworks (Mobile)" rather than "Mobile Development Frameworks").

How to clean up a Confluence wiki

  • It's good to periodically combine pages on your wiki so that new visitors don't click around and see a bunch of empty pages.
  • Pages which have sentences as titles are often worth getting rid of.
    • The long names make them difficult to search for, and so specific that it's likely users wouldn't mind having it combined with the likely-also-existing sibling pages with similarly-long names.
  • Having individual pages is helpful if you want to use the search bar to find that particular page.
  • Having individual pages is helpful if you want auto-updated links to that section on other pages.
  • When copying content from a page you intend to delete, you only need to click the 'Edit' button first if you're trying to copy hidden things (like 'expand' content)

Features I should look into using more

  • Blueprints
  • Page layout - I should think about how the different layouts might be useful. I suppose the three-column layout could be helpful for kanban...
  • Tables
  • Task lists - I could see myself using this for Rhymecraft, WhatDo, and any other project I want to keep on top of.
  • Emoticons - There are actually some useful emoticons in there: a green check-mark, a red square with an 'X' in it, a blue circle with a question mark in it, a hazard sign, and different-colored stars.
  • There's a converter for Markdown that'll paste in the converted HTML.
  • Horizontal rules.
  • You can have a Trello board on a page by providing the URL.
  • Macros
    • Administration
      • Why don't I see anything in this category?
    • Communication
      • I only see the "IM Presence", which I suppose could be helpful for pages where you collaborate with a particular group of people.
    • Confluence content
      • Create from template
      • Excerpt Include
      • Include Page: Includes the contents of a page within another. <-- I could see this being very helpful for keeping stuff organized...
      • Status - Communicate the status of a project, task or milestone with visual indicators.
      • Task report - Create a report of tasks from specific locations, people, status and more.
    • Development
      • The most-interesting one I see is the Jira macro for listing relevant Jira tickets, but I'm not really using Jira right now.
    • External content
      • Activity Stream - This might be helpful for making it clear to visitors that this wiki is being actively worked on.
      • TODO: Keep going through this.
    • Formatting
      • Highlight
      • Iframe
      • Info
      • Note
      • Panel
      • Tip
      • Warning
    • Media
      • Didn't see anything particularly interesting.
    • Navigation
      • You can create an anchor.
      • Page tree search
      • Page index
      • Navigation map
      • Search results
    • Reporting:
    • Visuals and images

An example structure for a company wiki

  • Employee-Specific Pages
    • Alok Kothari
    • David Gobaud
    • Dev Dasgupta
    • Nathan Wailes
  • General Knowledge
    • Responsibilities ()
      • Culture (General)

      • Onboarding / learning basic company knowledge (General)

      • Recruiting (General)
      • Help achieve company goals (General Responsibility)
    • Tools ()
      • The building / office (General Tool)
      • Meetings (General Tool)
      • Screencasts (General Tool)
    • Competitors  ← Not sure where this should go...

    • Customers  ← Not sure where this should go...

    • Strategy (Company-specific)  ← Not sure where this should go...

  • Team-Specific Pages
    • Eng
      • General Knowledge (Eng)
        • Responsibilities ()
        • Tools ()
      • Team-specific pages (Eng)
        • Data Analyst Team
          • General Knowledge (DA Team)
          • Manager (DA Team)
            • Responsibilities (DA Manager)
            • Tools (DA Manager)
          • Analysts (DA Team)
            • Responsibilities (DA)
            • Tools (DA)
        • Front-end Team
          • General Knowledge
            • Responsibilities ()
            • Tools ()
          • Team-specific pages
        • Infrastructure Team
          • General Knowledge
            • Responsibilities ()
            • Tools ()
          • Team-specific pages
        • Product X Team
          • General Knowledge
            • Responsibilities ()
            • Tools ()
          • Team-specific pages
    • Sales
      • General Knowledge (Sales)
        • Responsibilities ()
        • Tools ()
      • Team-specific pages (Sales)
        • SDR Team
          • General Knowledge
          • Responsibilities ()
          • Tools ()
          • Team-specific pages
        • AE Team
          • General Knowledge
          • Responsibilities ()
          • Tools ()
          • Team-specific pages
        • SE Team
          • General Knowledge
          • Responsibilities ()
          • Tools ()
          • Team-specific pages
        • AM Team
          • General Knowledge
          • Responsibilities ()
          • Tools ()
          • Team-specific pages
Potential problems
  • One potential problem is that for a person to know where to look for how to use a particular tool, they would need to know whether a different group at the company also needs to know how to use that same tool.
    • Example:
      • I need to do a screencast. I don't know if any other group at the company needs to know how to do a screencast. So do I look in my part of the wiki or the general part of the wiki?
    • Potential solution: Keep the page at the general level, but link to it at the lower (team-specific) levels.
  • No labels

Follow me on Twitter