Help Documentation Content

[manikus]

Think of this as a poll with free-form answers. :D

What content would you like to see included in the DC Help?

What content is mandatory for all users?

What doesn't belong in DC Help?

Should the Help be more like a manual or more like a F.A.Q.?

Thanks for you input, and remember if you don't let us know what you
want, you won't get it. ;)

[Lantry]

I would like to see basic walk throughs for each of the elements of the editor. I want examples to include the more exotic fields, as well as the obvious ones. I like a manual style better than a FAQ. I would also like a detail of what each of the files does within the main folders of the game. If I want to be able to hunt down and change/kill some odd function for the sake of my custom module, I would like a map to where it is. A general map is good enough if the files themselves are anotated, but otherwise I want to be able to count the nose hairs. That may be asking a lot, I don't really know. But it is what I want.

I would be willing to help create such a thing, assuming my kids allow me time to brain, nom nom nom. Fortunately, my eldest will be starting school this fall. I *may* find I have more time, occationally.

--- On Sun, 8/16/09, manikus <eric.al...@gmail.com> wrote:

[Michael-Forest]

I feel somewhat similar.  I'd prefer a manual style, and I'd like to see walkthroughs & explanations.

问乃一时之耻不问乃末代之耻

[Eric]

Help Documentation

Thank you for the input. This does help give me a nudge in the right
direction. :)

I've noted that the 'manual' style beats out the 'F.A.Q.' style hands
down. I've also noted the desire for tutorials and for explanations of
literally everything. I'm not sure if the tutorials will make it in
initially - but they will come. I'm only one guy after all. ;)

The new Help documentation is a complete rewrite of the old, from
scratch. But never fear, for those of you who know your way around the
old (current) Help, it will remain available on the Dungeon Craft
Wiki, and most of it is there now. :D Remember, if you'd like to add
something to the Wiki, all you need to do is register with SourceForge
(free and easy).
http://sourceforge.net/apps/mediawiki/uaf/index.php?title=Contents

If anyone would like to help me with writing the Help documentation,
please email or PM me (I'm cross-posting this message, so use
whichever is applicable).

[Michael-Forest]

I could possibly help with the writing.  I've got an English degree, but I'm new to technical writing.

问乃一时之耻不问乃末代之耻

[Lantry]

My daughter starts school this week. Once she is in, I will see what my schedule looks like with only one child eating my brain for a while. If it looks like the boy will let me, i will be willing to throw in creatively.

I will need you to give me a structured idea of what you need written, and as far as the more technical parts, you will need to explain it to me first. But once I understand it, I would be happy to flesh out examples, ect. If you just need basic walkthroughs of the old FRUA emulation functions, I can probably handle that. Assuming the boy lets me.


--- On Sat, 8/29/09, Eric <eric.al...@gmail.com> wrote:

> From: Eric <eric.al...@gmail.com>
> Subject: Re: Help Documentation Content
> To: "Dungeon Craft" <dungeo...@googlegroups.com>