Drupal Docs As ePub
Here is a proof of concept I was trying out this morning.
I wanted to read the SimpleTest documentation on my (non-internet connected) ereader so I made an ePub document out of the all the web pages. This centralizes the content into an (almost real) book that can be read on most electronic readers (with working Table Of Contents, embedded images, etc).
Due to the file upload restrictions (it doesn't recognize the '.epub' extension), you must change the '.html' to '.epub' after you download it, in order to read it.
Read moreCore Conversations on documentation at DrupalCon?
Hey all -
DrupalCon Chicago's Core Conversation proposals need to be in by next Friday. Jennifer (jhodgdon) and I have been pondering whether and what might make a good topic or two to pitch.
Please post with ideas and whether you'd be interested in attending a docs focused session, it'll help us gear our proposal towards something everyone will be interested in!
Thanks!
Read moreDITAmashup (structured/unstructured) example
Hi, All --
Awhile back I suggested a DITA "mash-up" structure and workflow process that I thought might be a candidate for the Drupal docs--this was based on my prior work as a DITA consultant, my reading of the Drupal doc group discussions, and my own understanding of what I assume are typical problems putting together an open-source, structured/unstructured collection of topics.
My business partner and I have put together a model DITAmashup collection on one of our sites that is accompanied by a post explaining how we did it and what we think are its benefits:
Read moreWhat defines Drupal?
We all use Drupal, build with it, code for it, sometimes even code it. But what is Drupal, really? What gives it its distinct identity? This page tries to gather the defining choices the project team has been focusing on over the course of years.
[Editor's note: If this is going to go into the Handbook, it needs more editing. See the style guide at http://drupal.org/node/338208 ]
Community experience
- The people on IRC channels #drupal, #drupal-contribute, and topical/regional channels
Docs Mentors
After a big discussion with some of the core devs who attended the PNW Drupal Summit last weekend, I've created a page for people who don't consider themselves part of the Docs Team to sign up as willing to mentor people working on Docs. http://drupal.org/node/936522
The idea is that people working on docs often need help with technical details of what they're documenting, and don't know who they can ask. The people I was talking to were more than willing to help out, and we also talked about pairing up docs people with contrib maintainers so they can help maintain project-specific docs.
Read moreDiscussion: Project-izing Handbook Maintenance
At dinner tonight Add1sun and I chewed over the question:
Why does Drupal's contrib maintenance model largely work, and handbook maintenance does not work?
While Drupal's contrib area is certainly not perfect, it has active maintenance on many projects, and a clear sense of ownership, and rules that go with that ownership. Everybody can contribute in the issue queue, and everybody can comment in the issue queue. But the maintainers are responsible for the their project.
Read moreShould the docs style guide apply to interface text?
A ping in #drupal-docs earlier has brought to my attention that the Docs style guide only applies to handbook and not explicitly to interface text in Drupal core/contrib.
I'd think it should apply so we get consistent text and grammar formatting Drupal-wide, but didn't want to make such a sweeping declaration without some consensus from the community at large.
Read moreAnybody else working on Accessibility docs yet?
I'm about to tackle a modest project in the Accessibility pages and just wanted to be sure I wasn't reproducing anyone else's work. Anyone here working on those docs? (Our Accessibility group actually is coordinating a project to improve that content. I am plugged in with [the rest of] them.) If so, please touch base with me so we can collaborate.
Read moreDocumentation-related activities at Drupalcon CPH
With a quick run-through of the program, I didn't see any talks of BoFs related to documentation on the CPH site.
I'm very interested in starting to help out with Drupal documentation, and I know there will be a need for a big push with D7. I'm just not sure where to start. I was hoping to meet up with some people in Copenhagen to give me a quick primer and sketch out some of the areas most in need of work.
Read moreA DITA documentation distribution for Drupal
Introduction
A couple of weeks ago we launched Modulecraft an awareness & fund-raising project that aims to rally Drupal professionals around a shared effort to create the ultimate toolset for Drupal business. The first fundraising round has as goal the development of a documentation distribution for Drupal that uses a similar approach as the localization server and that enables a distributed/federated documentation architecture for the Drupal project. As a Drupal user you'll be able to get a set of documentation from the drupal.org docs server imported into your own site. You will than be able to edit it and build subsets of the documentation for your own projects. You'll also be able to submit topics that were edited or created by you on your own infrastructure and add them as suggestions to the Drupal documentation server.
The following is a first proposal for the specification of the Documentation system we want to build as part of the modulecraft project. It is by no means complete, and it strongly needs your feedback. This is our first encounter with DITA and our ideas should really be proof checked by technical writers that have extensive experience using DITA. It also contains some proposes a somewhat exotic usage of RDFa, feedback is also very much needed here. In the coming days I'll be adding new sections to the specification here. This is a wiki so be bold! You can add comments either here or at the original posts on the Pronovix blog. I'll be incorporating feedback into this wiki.
Read more


