6

How can we facilitate the flow of useful content from Stack Exchange into CiviCRM's documentation?

This conversation began in civicrm-docs#32.

Docs-worthy content

Examples:

I think in some cases a simple link to SE would be appropriate, and in others it might be better to copy-paste content.

Non-docs-worthy content

By contrast, here's some content that, although recent and popular, doesn't belong in docs:

Personally, I think the majority of SE content is not worth migrating to our documentation. But for content that is, what can we do to shepherd it over to our docs?

4

Here's one idea that involves tracking content in SE with tags:

  1. Begin using the following tags

  2. To help evaluate what content to add or skip

    1. Search for the following (79 results currently)

      is:question answers:1.. score:8.. -[add-to-docs-to-do] -[add-to-docs-no] -[add-to-docs-done]

    2. Tag question with or

    3. Once we get this queue down to 0, documentarians like me could add an RSS feed to spot questions automatically.

  3. To help add content to docs

    1. Search for:

      [add-to-docs-to-do] -[add-to-docs-done]

    2. Add content to docs. (If it's already there, then consider trying to bring it to the surface a little more.)

    3. Tag question with

what does the SE community think of this idea? Would these tags present more clutter than they're worth?

  • The only thing I would add is that it would be good practice to link to the relevant section of the dev guide. I also wonder how to differentiate dev/user/admin guide content – ErichBSchulz Feb 13 '17 at 8:29
  • 1
    It might be interesting to take a sample of those 79 results and have a range of people assess them for do/don't add to docs to see what level of agreement there is. – Aidan Apr 14 '17 at 18:09
  • From Chris: I like it. I'd pick cividocs-todo, cividocs-no rather than add-to-docs-no, otherwise no complaints. – Sean Colsen May 10 '17 at 14:09
  • How do we limit usage of these tags? It's only helpful if not every random user is tagging their content as "add to docs". Curious. – Christia Nov 18 '17 at 7:43

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .