Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-45483

please hire real technical writers

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Answered
    • None
    • Documentation - All
    • None
    • We collect Confluence feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      NOTE: This suggestion is for Confluence Server. Using Confluence Cloud? See the corresponding suggestion.

      Your documentation is full of marketing garbage. It thinks it's being friendly but when you use too many words and sell me on something I'm already using, that's not friendly. It's annoying. Plus, it takes forever to get the answers I'm looking for because they are not the primary purpose of the writing. 

      Here's an example from your Pages and Blogs documentation. I went there when I was looking for how to create a page that hangs off a main page. Pages and Blogs sounded like a reasonable place to start. Here's what I got:
      "When you create any content in Confluence - whether it's taking down some quick notes from a meeting, writing a requirements page, or letting your teammates know about the company's latest marketing push - you'll either be creating it as a page or a blog post. You may be shocked to know that this page you're reading now, is, in fact, a Confluence page!

      Pages and blog posts are the two things that allow you to capture and share information in Confluence, and which one you use depends on what you want to do with your content. If you want the information to last, and possibly evolve over time, then you likely want to create a page; if the information is specific mainly to the current time-frame, and isn't going to change over time, then you'll most likely want to create it as a blog post. These aren't hard-and-fast rules; they're just pointers to give you a place to start."

      Here's a rewrite that's actually aimed at people who are looking for answers, not friends or marketing garbage. 

       

      "When you create any content in Confluence you are creating a page or a blog post.  For instance, the page you're reading now is a Confluence page.

      Create a page when you want the information to last, and possibly evolve over time.

      Create a blog post if the information is time-specific and will not change over time.

      These aren't hard-and-fast rules; they're just pointers to give you a place to start."

       

      See how I did that? I put the answers right where everyone can see them instead of burying it in a torrent of bullshit. Oops! Can I say bullshit?

      I just did!

      Carl Yorke

      Attachments

        Issue Links

          Activity

            People

              rrobins Rachel Robins
              57af50368fa4 Carl Yorke
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: