Style, structure, and guidelines at http://drupal.org/contribute/documentation/guide currently reads like it's specific to Documentation, but I think it should incorporate/encourage guidelines for all of drupal.org content.

The style guide should also support the creation of showcase, marketplace (organization), front page posts as well as community spotlights nodes. Currently the requirements and rules for these are a little haphazard and it would be great to have it all in one place.

As a first step, I would suggest moving 'Style, structure, and guidelines' up one level, out of 'Contribute to documentation' and retitle it "Drupal.org style guide" or even "Drupal.org content guide"

But first I just want to see what the docs team thinks.

Comments

arianek’s picture

arianek commented

I think there might be a really old issue about this somewhere... will see if I can find it. I am all for consistency sitewide with some of the sorts of things covered in the docs style guide, BUT it is very targeted to docs - ie. the instructions about "Voice" and some other things may not apply well to non docs text.

arianek’s picture

arianek commented

I'm not sure if this was the issue I was thinking of, it's only moderately aligned: #371974: Create a HTML style guide for Drupal.org webmasters - I think it may have actually been the merging with Drupal UI best practices I was thinking of, for ref #936382: Align Handbook Styleguide with UI Best practices

lisarex’s picture

lisarex commented

Ariane, I think #371974: Create a HTML style guide for Drupal.org webmasters is the one I was thinking of as well.

I don't think there's anything in "Online documentation style guide" that is non-relevant to the non-docs d.o. content. Much if it contains technical bits e.g. and I do think the voice stuff is relevant, like avoiding jargon and avoiding 'marketing speak'.

I would love to see http://drupal.org/node/1050556 move up a level and we continue to add sections to it (HTML, writing guide, images etc) and splitting some of http://drupal.org/contribute/documentation/guide/style into the right section, as appropriate.

arianek’s picture

arianek commented

that sounds right to me!

only concern is splitting up the current style guide - i'd rather keep it all in one place, even if it gets renamed, and we just have a link somewhere prominent for docs contributors

lisarex’s picture

lisarex commented
Assigned: Unassigned » lisarex

Cool, so here's my plan:

1. merge the node contents of Style, structure, and guidelines into Drupal.org style guide

2. Move the books within Style, structure, and guidelines to Drupal.org style guide book. (and I'll leave titles & content of these alone)

3. Give Drupal.org style guide a path of /drupalorg-style-guide

4. Redirect http://drupal.org/contribute/documentation/guide to /drupalorg-style-guide

5. Relax.

Oh wait, there's a ton more to do. :)

arianek’s picture

arianek commented

Hmm... I have a couple amendments:

1 - I really do want the style guide to be easily found via the contribute to docs section, so can you either leave http://drupal.org/contribute/documentation/guide intact and make it a little text blurb with a link to the new version?

2 - I think it would be much nicer if the path was something like.... http://drupal.org/style-guide

lisarex’s picture

lisarex commented
Status: Active » Needs review

@ariane, I've now moved the book from http://drupal.org/contribute/documentation/guide to the Style Guide.

I haven't done much with http://drupal.org/contribute/documentation/guide other than include a link over to the style guide. I'll leave it up to you to change the url path, title and contents to whatever it needs.

lisarex’s picture

lisarex commented
Title: Should 'Style, structure, and guidelines' be for all drupal.org content? » Create a single Drupal.org style guide

Renaming to reflect what happened.

lisarex’s picture

lisarex commented

Ooooh. This could probably be part of the Drupal.org Style Guide, or at least in the same book? http://drupal.org/drupalorg-site-maintainers-guide (will create another issue once #1164650: Consider renaming Drupal.org FAQ book to About Drupal.org? is sorted out.

arianek’s picture

arianek commented

I think http://drupal.org/drupalorg-site-maintainers-guide could go in the same book, but shouldn't be part of the styleguide - we don't want so much crammed in there that people get scared of it. ;)

(sorting the rest out on IRC) :)

lisarex’s picture

lisarex commented
Status: Needs review » Fixed

OK, have moved the /style-guide to Getting Involved guide, as it's definitely the right audience for it.

Marking as fixed, reopen if needed!

Automatically closed -- issue fixed for 2 weeks with no activity.