: Re: In searchable documentation, what function does a glossary serve? I work (with a team) on a large documentation set for a complex software product. We publish HTML and have built-in search

@Lee1909368

I have several online Help projects for various products and only one currently uses a glossary. We made an exception to define words that are key to the product, which is a sister-product and built on the same code; so key terms had to be updated for the audience and use, and for that reason, we use a glossary which helps customers who use both products. I also think it is a good tool for keeping track of acronyms. Last, our users have a wide-range of technical expertise, so we have to cover the bases and define things that might seem obvious, but are hopefully helpful. I think polling your users is valuable as well as asking your trainers for their opinions.

Load Full (0)

: When/why are action lines broken up into different entries? I'm speaking of more than one action line with no other text between them. I guess I'm asking if this is done because they relate

@Lee1909368

Load Full 2 Comments

: In a screenplay do use periods in action line/dialogue? Regardless of complete sentence do I use periods in action line or dialogue? It seems understood using ? And ! But when writing what

@Lee1909368

Load Full 2 Comments

: How Often To Proof Read Book I'm Self-Publishing I'm writing (to self-publish) a technical book aimed for computer-literate people with no technical background (but who want to get into the field).

@Lee1909368

Load Full 2 Comments

: When do I use single quotation marks when I am typing or writing? I'm new to this website so I need help. A couple punctuation marks confuse me. It's hard for me to remember stuff.

: Re: In searchable documentation, what function does a glossary serve? I work (with a team) on a large documentation set for a complex software product. We publish HTML and have built-in search

More posts by @Lee1909368

: When/why are action lines broken up into different entries? I'm speaking of more than one action line with no other text between them. I guess I'm asking if this is done because they relate

: In a screenplay do use periods in action line/dialogue? Regardless of complete sentence do I use periods in action line or dialogue? It seems understood using ? And ! But when writing what

: How Often To Proof Read Book I'm Self-Publishing I'm writing (to self-publish) a technical book aimed for computer-literate people with no technical background (but who want to get into the field).

: When do I use single quotation marks when I am typing or writing? I'm new to this website so I need help. A couple punctuation marks confuse me. It's hard for me to remember stuff.

Login to post a comment!

0 Comments

Back to top