Information architecture

jhodgdon's picture

Indexing expertise needed for the User Guide

We've been working on creating a User Guide -- the project page is here:
https://www.drupal.org/project/user_guide

One of the things we decided early on is that it should have an index. So, as the topics were written (by a variety of people), each one was given one or more index entries. This has resulted in an index that is sort of OK, but has some problems, because it was created by many people instead of a single professional indexer. You can currently see the index (as it is now) at:
https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/_index.html

Read more
kimmel's picture

Introduction to automation for content checking

This message has been cross posted to Drupal.org Improvements, Documentation Team, and Drupal.org Testing Infrastructure.

tl;dr

I want to use automation to improve d.o content quality. I do not have access to do this and I have been unable to get someone with access interested enough to get this project moving.

The long version

My vision for improving the Drupal Documentation and drupal.org can be broken into three equally important ideas:

Read more
arianek's picture

Core 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 more
avanraaphorst's picture

DITAmashup (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 more
arianek's picture

What's on your radar?

Hey fellow docs enthusiasts!

As some of you may have seen, there is going to be a big Docs Sprint in Vancouver in December (come join us if you're nearby!) The other part of what's going on that weekend, is that the core Docs Team members traveling here, as well as a few core devs (webchick, chx, and dmitrig01) will be gathering on Friday to discuss the Docs Team structure and initiatives in a dedicated retreat style afternoon.

We'll be discussing and brainstorming about things like:

Read more
Itangalo's picture

Documentation Robot: feedback appreciated

I recently got the opportunity to work on an idea that I've had for a few weeks – some kind of automized technical documentation of Drupal sites. It resulted in a rudimentary but working module Documentation Robot, collecting some technical information about the site where it is installed and summarizing it on a page.

It currently collects information about node types (including CCK fields), installed modules/projects, and user roles. In the pipe is also support for documenting views, panels, better CCK field documentation, and a tonne of other ideas I got. I also want to make the collected information re-usable in a number of different formats (for example DITA or creation of book nodes), but that is further off in the future.

Read more

A 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
arianek's picture

How to kill handbook comments

Just had a bit of a lightbulb moment (and maybe this idea has come up before?) about how to eventually kill comments on handbook pages. Someone asked how we could make sure conversations about a particular page were still visible if they were happening in the issue queue instead of as comments.

I thought, and this is what seemed like a good idea:

  • add a field on the issue node-add form for a referenced d.o NID (to reference the handbook page the issue is about)
  • build a view block for the handbook pages that displays any issues related to the page

Ta-da?

Read more
Subscribe with RSS Syndicate content