Drupal Documentation: Creating and editing nodes and comments

meierm @ Wed, 10/06/2004 - 16:44

Project:	Drupal
Component:	Documentation
Category:	task
Priority:	normal
Assigned:	meierm
Status:	active
Attachment:	nodes&comments.doc (20 KB)

Description

This documentation will help to serve as a starting point for users new to Drupal. The intention is to have a user guide that is simple enough to get the most basic of users active within Drupal but provide enough detail for more advanced users to take full advantage of the system.

The attached file is a short document outlining the goals and concerns of this documentation project.

Updates

Attachment:

definitions_interface.html (9.08 KB)

This is the rough draft for creating nodes and comments. Comments on content and layout are welcome.

This issue is now posted on Drupal at http://drupal.org/node/12174

Attachment:

definitions_interface_0.html (9.26 KB)

Here is a revised draft. Feedback on content welcome.

Attachment:

421PRJT2.html (2.43 KB)

Here is a revised walkthrough for creating content.

Attachment:

Drupal_documentation.zip (437.39 KB)

Revised draft. Hopefully the screenshots shot up this time.

Attachment:

Drupal_documentation_0.zip (528.62 KB)

Here is our final draft before some simple editing. Please feel free to continue giving us feedback!

Attachment:

Final.zip (528.65 KB)

Here is our final version of this documentation (creating/editing nodes and comments).

Looks good

bpatrick

Mon, 11/01/2004 - 18:52

Nice job, seems a little long, but I don't know what you could do about that since all that information has to be there and I don't know if it could really be split up... Maybe something to think about and if you see an opportunity of how it can be consolidated maybe consider it.

Content Comment

hoffmasj

Mon, 11/01/2004 - 18:48

Content wise, I think you are on track. The info seems to come in short blocks. My suggestion would be to make it flow a bit better by putting some of it in sentense form and adding some transitions.

suggestions

cel4145

Wed, 10/27/2004 - 05:47

1) Good comment below about breaking that first paragraph. Also, why not make that list of node types a list, and in doing so, give a brief definition with each. Talk to the node group and see how much you need to explain. You may only need a list. That way, the advanced user can get the basic explanation all up front without having to scroll down through all the images.

2) If you do one, then you only need one image, the basic content display (I suggest using a "page" node type). Underneath in a list, explain the visual elements. Then you can start a new paragraph, explain that there might be additional options and why, and then include a list of them.

3) It's important to specify what is required in the visual elements in the basic page type.

4) Don't forget to explain the automatic teaser and user of the break element.

5) Also mention categories/taxonomy elements as a possible choice.

good ideas

kanichol

Wed, 10/27/2004 - 18:31

Thanks for the suggestions. It was hard to do a first draft of the definitions because I wasn't sure yet what the other groups were writing (nodes, taxonomy, etc.). We were planning on linking to the more complete definitions of the different kinds of nodes as well. Now that we have a better idea of what the other groups are doing, we'll be more able to adapt our documentation appropriately.

This looks really good. Ever

ksailer

Mon, 10/25/2004 - 18:58

This looks really good. Everything is clearly explained and easy to understand. My only suggestion is that you break up the first paragraph. The information in it is great, but it is a little hard to stay with it because it is in one big lump paragraph.

style

conradtl

Mon, 10/25/2004 - 18:55

Your style of writing seems very good. You might want to split up the first paragraph so it is not as long. The walk through at the bottom appears useful for the beginner user but I don't know if it is necessary or if it follows the style you are writing in.

first paragraph

kanichol

Wed, 10/27/2004 - 18:37

Thanks for the suggestion to break up the first paragraph. That seems t be the consensus. We'll incorporate the definitions more and link where appropriate.

Walkthrough

bpatrick

Mon, 10/25/2004 - 18:54

I like the walk through and think it should come first. Then the definitions split up by category with an appropriate screenshot, like you have. Within the categories you could have bulleted listings of different terms along with their definitions that go with that category.

Navigation

User login

Who's online