Hello, I’m on CiviCRM’s Community Council and working on documentation. We are considering using the Diataxis framework to guide and organize updates to existing CiviCRM documentation. Is there a contact with whom I could correspond about this topic? Thanks. [Mod edit to remove user’s email address after this post was made public by other moderators]
@DanieleProcida might be a good person to talk to
@DVHirst865 it’s great that you are thinking about Diátaxis as an organizing principle. What sort of information are you looking for? The CPython doc workers are very pro-Diátaxis, but it’s been slow-going making changes along those lines.
One thing to remember about the framework is that it’s not about having four separate sections of docs. The different perspectives and approaches can be intermixed at any level. The important guidance is to know which perspective you are using for any given piece of writing.
Ned,
Thank you for your comments and interest in our activities. We have been working these past several days to better understand the Diataxis Framework and see how we can begin working its structure schema into CiviCRM’s documentation. We agree that it will be a slow process, but it has definitely given us useful direction in seeking ways forward. We were looking for examples of how other Open Source projects have used the Framework, and, indeed, have found several very useful instances.
Peace,
Don Hirst, Member
CiviCRM Community Council
Documentation Working Group