>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #114078. --> Reported by: [Tresler](https://www.drupal.org/user/26929) >>> <p>Created this issue and assigned to myself to give a venue for discussion of the 'First Steps Handbook'. </p> <p>The idea is this. The drupal documentation exists. Sure there is always room for improvement, but all the essentials are here. However two outstanding issues prevent people from finding what they need, as they need. </p> <p>A) There are some many aspects of drupal that you can't explain it the same way to any two 'types' of user.</p> <p>B) There is no built in doc-only search</p> <p>Senpai's thrown the gauntlet on B here: <a href="http://drupal.org/node/113589">http://drupal.org/node/113589</a></p> <p>This is my take on A. I want to create a handbook that is user type specific. The main role of this book will be to designate a 'path' through drupal docs for various types of users. </p> <p>For example, top level page will be something like:</p> <p>Click here is you are looking at drupal from a design perspective.<br> Click here is you are looking at drupal from a php/mysql developers perspective.<br> Click here is you are looking at drupal from a business person's perspective. </p> <p>Each of these would lead to a series of pages that are relatively version independent. A designer would first want to know about the phptemplate engine, and theming. A developer would want to know about module development. A vanilla admin would need to know the basics of taxonomy. </p> <p>Each 'path' would eventually lead through the basics of all the docs - with the goal of weaning the user off the path and onto the doc itself, however, each would do it in a different order, with some different wording to help a 'type' of user 'get' drupal. </p> <p>So what I'd like, before I start this is feedback. Is this useful, needed, a waste of my time, welcome?</p> <p>Background:</p> <p>From my 'application' for the team - <a href="http://drupal.org/node/114038:">http://drupal.org/node/114038:</a></p> <blockquote><p>Webchick, Senpai, and I had a IRC conversation about starting a top level book that was as version independent as possible, but referenced existing doc as a path through doc dependent on profession. Kind of a 'Choose your own Adventure' through documentation.</p></blockquote> <p>Webchick's follow up:</p> <blockquote><p>The folks in the #drupal-dojo channel have identified the biggest problem with Drupal's documentation not the lack of it, or the fact that it's poorly written, but the fact that it's difficult to find. The idea is to have a collection of starting points for various target audiences that aggregate appropriate links to elsewhere in the handbook. I think this is an excellent idea, and might even be able to take over the existing /handbooks link at some point if it works well. In the meantime though, it can't hurt</p></blockquote> <p>Below is the conversation that led to all this, with irrelevant information or other conversations snipped out. I took a good deal of editorial liberty cutting, so if anyone feels that I didn't get all that they were saying chime in:</p> <blockquote><p><gusaus> i think we most def need to figure out a better way to centralize all the scattered ideas and communications - i know we're all thinking about it...<br> <snip><br> <webchick> gusaus: I dunno. From my perspective we already have that centralization: the handbook.<br> <gusaus> i wish there was a way that mediawiki could easily integrate with 'drupal' wiki<br> <snip><br> <webchick> The documentation would suck a lot less. :D<br> <snip><br> <senpai> webchick, It's true that we already hav the Handbooks. My biggest fear with this ne Dojo progect, and the resulting onslaught of info, is that the Handbook Pages are going to become overly-heavy for newbs to grasp<br> <webchick> but unless those efforts ultimately end up back in the handbook, it doesn't benefit the widest swath of people iti could.<br> <snip><br> <webchick> Senpai: so does it make sense to make a new handbook (or seciton or whatever) for newbie developers? and one for newbie themers..?<br> <webchick> I am all about restructuring things so it's more logical and easy for people.<br> <snip><br> <webchick> we're not 'locked' into the current structure.. the handbook is an incremental work in progress. ;)<br> <webchick> It used to be one huge ass book, so this is an improvement. ;)<br> <snip><br> <samtresler> The task list is good - if we keep up on it.<br> <webchick> but asking the instructor to a) prepare a lesson, b) teach it, and then c) document it in the handbook is too much. so the responsibility has to fall to some other person/s<br> <snip><br> <samtresler> webchick: agreed - that and the 'students' would get more benefit from writing the doc anyway.<br> <webchick> Yep.<br> <webchick> There is seriously nothing that helps you understand material better than trying to explain it tomsomeone. :)<br> <snip><br> <samtresler> Seems like we want to add a handbook to drupal.org maybe... The docs are an intruction book, and a Dojo-esque book that is lesson by lesson write ups heavily crosslinked - but even as I write that I think of upkeep, etc, and cringe<br> <senpai> sam, no! Let's not crosslink!<br> <senpai> Bad!<br> <webchick> I can create a book for you right now if you want. :)<br> <senpai> Very bad!<br> <webchick> though I think you can too.<br> <samtresler> Senpai: Ok, why?<br> <webchick> hm? crosslinking bad?<br> <senpai> Too much upkeep, just like you said<br> <senpai> The only thing worse than having no info is having wrong info<br> <webchick> crosslinking is the opposite of upkeep... it's "wanna learn more about CVS? there's a whole thing about it right here: X"<br> <snip><br> <samtresler> webchick: nope -Thats what I had in mind.<br> <samtresler> A handbook that was SEQUENTIAL that went through drupal from a students persepective - adding some order to the current handbook by referncing it in a step-by-step fashion<br> <webchick> There should be as little duplication as possible, imo... so if there's already a part of the handbook that talks about topic X, then re-work that X page so that it's understandable and link to it from your thing.<br> <webchick> samtresler: yeah, wicked. i love it.<br> <snip><br> <samtresler> exactly... this just solve the "Where do I start" problem every noob hits<br> <senpai> sam, I hated that phase....<br> * webchick had a very bizarre noob phase :P<br> <senpai> I razed three drupal installs when I first started<br> <senpai> Burned them to the ground<br> <snip><br> <samtresler> Well - I'm still hitting it and I've been at this for a year and a half - The docs<br> <samtresler> are very well written, and you can't find what you need to save your life<br> <samtresler> webchick had SoC, no?<br> <webchick> samtresler: yeah...<br> <senpai> The problem is not the docs's lack-of-info<br> <snip><br> <samtresler> I need to think on this and examine the existing doc some more<br> <webchick> samtresler: so i'm curious how you're thinking of approaching the more 'contextual' step-by-step method.<br> <webchick> mainly because there are a plethora of audiences:<br> <samtresler> webchick: Me too!<br> <snip><br> <webchick> 1. I'm a complete newbie ... I don't even know HTML. I want a basic blog without any frills.<br> <snip><br> <webchick> 2. I'm coming from Joomla!/Typo3/Plone/X . I want to know how to do X task I'm familiar with in Drupal.<br> <snip><br> <samtresler> remember Choose Your Own Adventure Books<br> <samtresler> I think it needs to be that<br> <webchick> 3. I'm a master PHP hacker, but know nothing about Drupal. How do I make modules and extend Drupal's functionality?<br> <senpai> (turn to page 34)<br> <snip><br> <webchick> haha indeed. ;)<br> <samtresler> no really<br> <webchick> But seriously though.<br> <webchick> there are at least 10 completely distinct "starting points" I could think of off the top of my head.<br> <webchick> 4. I'm a business person/manager/X, and trying to evaluate if Drupal is right for me.<br> <webchick> 5. I want to build "blah" site. How can I do it in Drupal?<br> <samtresler> That's my point of the choose your own adventure. The work is in the linking - the first page says I want to learn drupal from x perspective<br> <webchick> 6. I'm a photoshop whiz. How do I translate my masterpieces into Drupal?<br> <senpai> No webchick, there's only one starting point. For the newb who has just downloaded 5.0, and run the easy-as-cake installer, they have only one thing on their mind. "How Do I Do x.."<br> <webchick> 7. I've been using Drupal for awhile as a basic user, and now want to take it to the next level...<br> <samtresler> and has those 5+ options. And each one takes you to an overview of Drupal from that perspective - and those are the only 5-10 pages in the book - the rest is a list of the order in which you should absorb the doc.<br> <webchick> Senpai: spend some time reading the support forums...<br> <snip><br> <webchick> there are MANY many different starting points.<br> <senpai> kay<br> <samtresler> Designers start with CSS includes and phptemplate engine<br> <webchick> It's actually mind boggling.<br> <webchick> and it makes writing documentation very very hard.<br> * josh_k (n=joshk@75.111.49.109) has joined #drupal-dojo<br> <webchick> Which is why sam's idea of having a "jump off page" for each audience member is such an awesome idea.<br> <webchick> So existing pages are not re-written.<br> <webchick> just aggregated in a way that makes sense to target audience X<br> <samtresler> And e DON'T write much new<br> <webchick> right.<br> <webchick> It's mostly a scavenger hunt, plus a general clean-up.<br> <samtresler> just put in in an order for each person to 'grok' drupal in their own way<br> <webchick> I'm sure you'll find docs with incorrect / unclear info.<br> <samtresler> and clean as we go<br> <webchick> yep.<br> <senpai> well, that'd be a really good way to go about it, but I'm sorta curious as to how you've figure out how to server each audience their own set of info?<br> <webchick> That, imo, is the way to do it.<br> <samtresler> Senpai: umm, with hyperlinks?<br> <samtresler> Senpai - what do yo mean?<br> <senpai> Too many links = confusion for most surfers tho<br> <webchick> Senpai: you put yourselves in their shoes. Or read up on support requests and jot down notes on the things these types of people talk about. Or just go find someone in that boat and ask them. ;)<br> <snip><br> <webchick> Hm. I'm not thinking it would be just a big link farm.<br> <webchick> I'm thinking there would be contextual information there.<br> <samtresler> webchick: sure,<br> <webchick> But the main idea is, you're writing context around existing pages.<br> <samtresler> yes<br> <webchick> And laying it out in a step 1, step 2...<br> <snip><br> <samtresler> right and it all comes in the form of a few sentences about how those all play together but links to their respective pages for more actual doc.<br> <webchick> Senpai: once you guys get a good "I am a X and I'm looking for info on Y" section going, that might very well be a logical replacement for the /handbooks page.<br> <snip><br> <samtresler> webchick: OK - dammit, how do I start this... I can create a book on d.o? you say? or do I need to apply for doc team first?<br> <webchick> samtresler: nah, anyone can create a book page.<br> <snip><br> <webchick> Oh. The title of the section of the handbook that sam's making.<br> <senpai> ahh<br> <senpai> I'd call it "First Steps"<br> <webchick> Yeah that's good.<br> <webchick> Call it "Maurice" -- really confuse people. ;)<br> <senpai> If it's targeting Business owners, coders, newbs, and graphic artists<br> <senpai> Then it can branch down from there.<br> <senpai> Ziggy! Call it Ziggy!<br> <webchick> haha<br> <samtresler> *sigh*<br> <snip><br> <samtresler> Probably talk to Sepeck first? copy this conversation and let him take a look-see<br> <snip><br> <samtresler> OK - I'll start plotting.... I mean outlining<br> <webchick> well. i just clicked the submit button. ;) not sure when my reply will actually appear, but.. ;)<br> <snip><br> <webchick> Ok, I really gotta go back to work now. ;) Thanks for the chat though, that was awesome.<br> * Senpai has quit ("The computer fell asleep")<br> <gusaus> dojo slaves are now very busy! </gusaus></webchick></snip></webchick></samtresler></snip></samtresler></snip></samtresler></webchick></senpai></senpai></senpai></webchick></webchick></senpai></senpai></webchick></snip></webchick></samtresler></snip></webchick></samtresler></snip></webchick></samtresler></webchick></samtresler></webchick></webchick></snip></webchick></senpai></samtresler></samtresler></webchick></senpai></webchick></samtresler></webchick></samtresler></webchick></webchick></samtresler></webchick></webchick></webchick></webchick></webchick></samtresler></senpai></webchick></snip></webchick></samtresler></webchick></senpai></webchick></samtresler></webchick></webchick></webchick></webchick></samtresler></webchick></snip></senpai></webchick></samtresler></samtresler></snip></webchick></snip></webchick></snip></samtresler></webchick></webchick></samtresler></snip></senpai></webchick></samtresler></samtresler></samtresler></snip></senpai></senpai></senpai></samtresler></snip></webchick></webchick></samtresler></samtresler></snip></webchick></senpai></senpai></webchick></samtresler></webchick></senpai></webchick></senpai></senpai></samtresler></snip></webchick></webchick></samtresler></snip></webchick></samtresler></snip></webchick></webchick></snip></webchick></webchick></snip></webchick></senpai></snip></webchick></snip></gusaus></webchick></snip></gusaus></p></blockquote>