What do you want to see in updated documetation?

[rjcurrie]

Hey there, Hero Desinger fans!

Because Dan has added so many juicy features since the release of v2, he and I have decided to do an updated version of the documentation to cover these features. This also seems like a good chance to revisit what is already there and see if there is a better way to present it.

So, here is your chance to tell me what you want to see in the docs. Are there things that are poorly explained in your mind? Are there things I missed (besides those added since v2) and should be included? Is there a different way you would like to see the documentation arranged? If so, reply to this thread. Pretty much everything about the docs is open to discussion and I will consider all suggestions. Also, feel free to comment on other posters' suggestions, so I can get a feel for how the community as a whole feels.

My goal is to release updated documentation sometime between the end of March and the middle of April.

Your Hero Designer Documentor,

Rod Currie


Dan: Can you please make this a sticky thread?

[Mole]

If posible, it would be nice to see a few specific examples of how to create a Custom Characteristic and how to create a Custom Figured Characteristic.

Maybe also some references for novices to start learning HTML, RTF, etc. so they can modify Export Templates.

[rjcurrie]

I definitely plan on adding info on creating custom characteristics -- that's a feature added since v2 and the Creating An Extension Template will be updated to reflect them. And thanks for pointing out that I should show both primary and figured custom characteristics -- the current version kind of shows how to do a figured characteristic using a renamed "DEF" characteristic, but the update will definitely use CUSTOM1, CUSTOM2 ... CUSTOM10 for such things as they now exist.

As for references on learning HTML, RTF, etc., that's a good idea. Does anyone have any good references they would like to recommend for such things?

[Vanguard]

Would also be nice to get a little description of what the various tags do as well as maybe an example as to how to use them.

[rjcurrie]

Are you referring to tags in export templates or in character templates?

[Vanguard]

Export templates for the most part.

[rjcurrie]

Let me pose a few questions and see if that spurs some response to this rather moribund thread. :)

1. Should the manual have an index? If so, should it be detailed and point you to every mention of say, multipower, in the docs? Or should it be more general and more aimed towards specific tasks?

2. Are there some specific "How Do I ...?" questions that have been asked a lot on these boards that should be more directly addressed by the docs? Perhaps, there should be a "How Do I ..." section (at the beginning? or at the end?) that poses these questions, gives a very brief answer and points out the specific section or sections of the docs that will give more details. What do you think?

3. Are there areas where additional screenshots or diagrams could help explain more difficult concepts?

4. Are there any specific quirks about certain abilities that you feel should be pointed out but currently aren't?

5. For those of you who have worked with creating export templates, are there specific issues that should be clearly spelled out in the manual? Do you have any advice that you think should be pointed out to anyone attempting to create export templates?

6. Similarly for character templates, are there issues that should be dealt with in more depth? It would seem that NCM is one of these. There are probably more. As with export templates, does anyone who has worked with character templates have any advice they feel should be shared with other users?

7. Is there simply anything that you wanted to know about but just couldn't find?

8. I think that any discussion of plug-ins other than the fact they exist and what they are intended for is beyond the scope of the manual. I will probably just give an appropriate e-mail address where an advanced user interested in the topic can contact Dan and get more information.

Rod

[Talon]

Originally posted by rjcurrie
Let me pose a few questions and see if that spurs some response to this rather moribund thread. :)

1. Should the manual have an index? If so, should it be detailed and point you to every mention of say, multipower, in the docs? Or should it be more general and more aimed towards specific tasks?

If you have an index, it'll have to live up to Steve standards or everyone will dis it. I'd make it very detailed.


2. Are there some specific "How Do I ...?" questions that have been asked a lot on these boards that should be more directly addressed by the docs? Perhaps, there should be a "How Do I ..." section (at the beginning? or at the end?) that poses these questions, gives a very brief answer and points out the specific section or sections of the docs that will give more details. What do you think?

Lists, Compound Powers, Equipment, Skill Enhancers, Power Frameworks all come to mind.

Also, I had some comments last time you posted the docs for comment about ordering the different sections -- I think the order could be revised to make it more newbie-friendly.



5. For those of you who have worked with creating export templates, are there specific issues that should be clearly spelled out in the manual? Do you have any advice that you think should be pointed out to anyone attempting to create export templates?

I think discussion of the different tags, with a few examples, will be helpful. Right now they are just presented in a huge blob which makes them difficult to use. Also point to the constantly-updated online list -- otherwise people will get frustrated when stuff changes due to updates.

[Simon]

Originally posted by Talon
I think discussion of the different tags, with a few examples, will be helpful. Right now they are just presented in a huge blob which makes them difficult to use. Also point to the constantly-updated online list -- otherwise people will get frustrated when stuff changes due to updates.
I should point out that the only changes that I tend to make to the export tag list is adding in new tags. Case in point, even with the large number of changes that have taken place in the tag structure for exporting, early v1 export templates still work just fine.

Checking the online list is a good idea, as it may show a new tag structure that makes a certain task easier, but it's not necessary to verify the template that you're building.

[DarkAcroyear]

I'm an old-time hero system GM, but new to Hero Designer. I am still scanning the manual in PDF format, and have yet to print it out.

From that perspective, the problem I'm still having with the documentation is figuring out how to make the various power frameworks. So the "How do I...?" and the "...just couldn't find" categories are the most important to me right now. Quick access into making characters right away for a new user. (If someone can point me in the right direction for frameworks it would be appreciated :-)

If the software treats something in a different way from how we traditionally write up our characters, that should be pointed out and referenced.

For a document of this size an index is probably not necessary as long as the TOC is good.

[Derek Hiemforth]

Originally posted by DarkAcroyear
(If someone can point me in the right direction for frameworks it would be appreciated :-)Click on the Powers tab. Click on Power Frameworks. (It's in the menu bar at the top of the Powers tab... not in the powers list on the right.) Add the Framework you want. Then add powers. :)

If the software treats something in a different way from how we traditionally write up our characters, that should be pointed out and referenced.Who's "we", and what's "traditional"? :)

[DarkAcroyear]

Thanks, I couldn't see that those were selectable items on my system. :)

I suppose "we" would be us newbies to HD, and "traditional" would be what ever design process we are used using that involves a mechanical pencil and an engineering pad. :D


Originally posted by Derek Hiemforth
Click on the Powers tab. Click on Power Frameworks. (It's in the menu bar at the top of the Powers tab... not in the powers list on the right.) Add the Framework you want. Then add powers. :)
Who's "we", and what's "traditional"? :)

[RPMiller]

It was mentioned above already so I'll second the desire to see more information regarding the Export Tags.

The biggest problem I run into is trying to figure out which tag should be used in a given situation, and whether that tag can format an item by putting the formatting inside the container or in front of the container.

I think a description next to each tag that refers to a specific item in HD would be what was needed.

Something like:
IS_LIST - Use this tag to check to see if item is a List, EC, MP, or VPP. Formatting should be placed inside container to format the item.

If that was correct, I don't really know. See we need better documentation. ;)

[KA.]

rjcurrie,
I would like to see something that shows the various screen, witn a "key" or annotation explaining everything that we might see on them.

Not every screen, but the main ones.

For example, I recently tried creating characters using HD v2.

I notice that when I highlight certain skills, powers, etc. the select button for most of them turns Green (Acrobatics, Acting, Breakfall, etc.), however, on others it turns Yellow (Animal Handler, Computer Programming).

I am guessing that this has something to do with the Skill itself, perhaps the Skills that turn yellow have underlying options that need to be selected, but I don't actually "know" that.

I didn't find anything on this in the current documentation, at least not by searching on the word "yellow".

Which brings up another point, it would be good to make sure that instead of using a generic term like "highlight", to be as specific as possible when describing things that the program does in the doc.

That way, if you are searching for what it means when something turns "yellow" or shows up in "bold" it will be a lot easier to find.

KA.

P.S. I hope this didn't sound rude, sometimes when I am trying to be specific, I can seem a bit hostile. Really it is more like "Just the facts."
I think you are doing a great job, and I will look forward to the new Doc.

[Shirizaan]

It would be nice if you would show examples of character templates as well... and a list of tags with descriptions for that...

[RPMiller]

It would be nice if you would show examples of character templates as well... and a list of tags with descriptions for that...
Ok, I'll say it before someone else does... Did you read the existing docs yet? There are descriptions of the tags in there. Also, you can open any character template in your text editor of choice to see how they are built.

Or were you looking for something else?

Hope that helps! :D

[Shirizaan]

Specifically the new CUSTOM tags... and yes, I've read the docs and have looked at how its structured. The thing that I'm having problems determining are all of the options in each tag.

[RPMiller]

The only CUSTOM tags that I'm aware of, are for Characteristics. Are those the ones you are referring to? Are you looking for the options on the CUSTOM tags, or all tags in general?

The only difference between the CUSTOM tags and regular characteristic tags is the name. All the options listed on pg. 43 are the same for the CUSTOM tags.

[Snarf]

2. Are there some specific "How Do I ...?" questions that have been asked a lot on these boards that should be more directly addressed by the docs? Perhaps, there should be a "How Do I ..." section (at the beginning? or at the end?) that poses these questions, gives a very brief answer and points out the specific section or sections of the docs that will give more details. What do you think?
Certain versions of powers, such as Simplified Healing and Regeneration, don't appear in the power list or anywhere obvious due to deliberate design decisions. An explanation of how to make them out of healing, and any similarly counterintuitive powers, would help solve some of the newbie questions that end up on the forum.

For instance, the words "simplified healing" don't exist anywhere in the program because it doesn't affect the purchase of the power. The easiest way to indicate it is to rename the power display. Regeneration is made by selecting a series of modifiers and a special Regeneration Only version of extra time. It isn't rocket science, but there will always be a percentage of new users getting confused about stuff like this.

[rjcurrie]

I suppose this is possible (saying how to do things like Simplified Healing and Regeneration) but then again those are not really individual Powers just special cases of the Healing Power. As for Regeneration, it is built exactly the way it is described as being built in the Hero System Fifth Edition rulebook. But perhaps I can at least make a minor mention of them.

Thanks for the input,

Rod

[nedbush]

I'd like an alternate copy of the documentation designed for viewing on a computer instead of printing out all 50+ pages. Maybe HTML format?

Maybe also some guidelines on the standard templates, etc.

[Simon]

I'd like an alternate copy of the documentation designed for viewing on a computer instead of printing out all 50+ pages. Maybe HTML format?

Maybe also some guidelines on the standard templates, etc.
Umm.....PDF _is_ designed for computer viewing....with capabilities that HTML lacks. What problems are you having viewing the docs on your computer?

[Aroooo]

Dumb question: Where are the docs for the export template guidelines?

Aroooo

[Simon]

Dumb question: Where are the docs for the export template guidelines?

Aroooo
"Export Tag Matrix" -- sticky thread at the top of the forum.

[Aroooo]

"Export Tag Matrix" -- sticky thread at the top of the forum.

Thats it. I'm going to bed now :)

Aroooo

[nedbush]

Umm.....PDF _is_ designed for computer viewing....with capabilities that HTML lacks. What problems are you having viewing the docs on your computer?

The document is formatted in two columns plus sidebars, so if I make the text big enough to read I have to keep going page up, page down, page up, etc. to read all the columns top to bottom. Just not a natural way to read anything. I'd assume that whoever formatted the document either never tried to use it on a computer instead of printed out or has a really huge monitor so that they can read the fonts even when text is formatted to show a whole page at a time.

[rjcurrie]

I have a 19" monitor and was told that I should format it as close to the Hero standard as possible because we were assuming that most people would print it out.

Rod

[keithcurtis]

Here's a helpful pdf hint for those (2% or so) of us reading them on a Mac-based laptop. Use Preview instead of Adobe's PDF Reader. It loads and prints faster for one thing. But the coolest thing is the ability to rotate the display 90%. I hold my laptop like a book and look at the screen in the long direction. I can fit a whole legible 8 1/2 x 11 page and read it comfortably. I get a lot more out of Digital Hero since discovering this.

PC users, is there an equivalent on Windows?

K
e
i
t
h
"
P
D
F
"
C
u
r
t
i
s

[RPMiller]

Here's a helpful pdf hint for those (2% or so) of us reading them on a Mac-based laptop. Use Preview instead of Adobe's PDF Reader. It loads and prints faster for one thing. But the coolest thing is the ability to rotate the display 90%. I hold my laptop like a book and look at the screen in the long direction. I can fit a whole legible 8 1/2 x 11 page and read it comfortably. I get a lot more out of Digital Hero since discovering this.

PC users, is there an equivalent on Windows?

K
e
i
t
h
"
P
D
F
"
C
u
r
t
i
s
If memory serves, I believe the Journal Viewer has that ability, but it isn't something that I've looked into. That is a really interesting idea though.

Thanks!

[SteveZilla]

I want to see more than just a list of export tags & containers. While a good amount is reasonably self-explanatory, some of it I find very cryptic. An expanded (not greatly, just a little more than a bare list) explanation of how to *use* them would help a whole lot.