Ensure all references to technical subjects are prefaced with accessible text about civicrm-user-guide HOT 6 OPEN

Agreed. Now I'm trying to figure out how we can implement this change from a practical perspective.

@michaelmcandrew do you have ideas for how to make this ticket more actionable? I like the "separate tickets" idea, but I'm still not sure what criteria should be for this ticket to be "done" and closed. So far it would seem to require a complete manual scan of the User Guide which feels too demanding.

Our Style Guide currently says

For the User Guide only: We try and limit the content to tasks that the user can perform from the front end. This means that we don't go into detailed steps about installation or system administration tasks. We do however let people know that there are system administrator tasks out there (setting up an SSL certificate, configuring CiviMail etc.) and point them in the right direction when they want to know about those tasks.

Here's my proposal for how to act on this ticket:

1. Add your suggested text to the aforementioned section of the Style Guide
2. Close this ticket
3. Keep our eyes out (just personally, not programmatically) for changes needed to bring the User Guide into compliance with this Style Guide criteria, and add new tickets as necessary.

What do you think about that @michaelmcandrew ?

from civicrm-user-guide.

yeah - I think Style guide is the place for this. The other option would be to have a big sprint task label or similar that we could attach to tickets that are fairly mammouth but would be acheivable at a sprint if you split the work between 4 or 5 people, if you are into those kind of tickets that are open for a while, or you want to keep them closed. up to you.

from civicrm-user-guide.

This issue has had no activity in 60 days and has been marked as stale, it will be closed in 10 days.

from civicrm-user-guide.

I anticipate incorporating the concepts discussed in this issue in my development of a CiviCRM Documentation Guide.

from civicrm-user-guide.

Hi @dvhirst just to be clear - at this stage I am not neccessarily green-lighting adding a new documentation book - the content may make more sense living in the dev guide where it is now (there would need to be a significant amount of content to justify a new core book).

from civicrm-user-guide.

Either way - I look forward to reviewing the content :-)

from civicrm-user-guide.