New answers tagged

3

Wikipedia has this short list of graphical elements for interfaces that use the prevailing WIMP paradigm. https://en.wikipedia.org/wiki/List_of_graphical_user_interface_elements According to the example you've provided above, I think what you have there is a zoomable popup control or zoomable popup widget Hope this helps! Personally I've never liked ...


0

It is the same as any writing project: tell a story. In technical writing, it is not only just as important to tell a story, it might be even more important than in other disciplines. The material can be dry or very conceptually mysterious. You might be tempted to read an HTTP spec and just crib dryly from that. But if you think about it, HTTP is what ...


0

The AP is very similar to the Chicago Manual of Style, but much easier to use. Why go against the grain? You're going to reach the broadest possible audience with the AP, which I believe should be the ultimate goal here.


1

Audience can be broad. You may have some folks who are new, they may need that explanation (just a gist) to remind them that concept (yes, even http!). So you can have a stand alone standard definition, and right after that a funny analogy or humorous view at it. This would make the "high tech folk" appreciate a humorous way to look at something they feel ...


0

It sounds like "high tech" is the ideal audience. You don't have to dumb it down or use analogies. Your explanation can be, like, two sentences. Look up the definition in a few places and rewrite it in your own words.


0

You can't do that in DITA or any other XML language because the first thing that sees the content is the XML parser, which has no idea what any of the tags mean. Therefore it will see <b> as a tag, regardless of what element it is in. The way you tell XML to ignore markup in a section of a document is with CDATA marked sections <body> This ...


0

You can use Sherlock Holmes, since he is a public domain fictional character and he has a famous fictional address. I think this adds a little fun but not so much that it is distracting, and it feels more like a real person than “John Smith, 123 Main Street.” Sherlock Holmes 221B Baker Street London, England NW1 6XE Of course you can localize it also if ...


0

Your description will need to tell what the product is, and describe it in the best possible light. Use vivid prose to accentuate the positive, and never mention the negative. You are seeking to draw buyers into wanting to but the product, so you should also identify a felt need that this product will address. Hope this helps!


1

Write and seek feedback! Useful ways to get feedback: Volunteer for writing projects that will be reviewed critically. Reviewers are often more attentive and critical when reviewing promotional content, rather than technical. However, for many products, promotional content needs to be technical. As a technical writer, you should know your company's ...


1

The key to good tech writing is not style. Style helps with clarity, and that is useful, but it is not enough. They key is to present the right information to enable a particular user, with a particular background and set of skills, to complete a task. The goal is correct action, not necessarily understanding. Too much information is almost as bad as not ...


1

The first is most often seen. Most journals have their own specifications for citations, but that one is very common. Also note you don't always have to place them at the end of a sentence. See here for examples.


1

You can create responsive HTML5 outputs that have interactive elements, like slideshows, using native MadCap Flare functionality AND you can extend Flare's native functionality by incorporating a pre-coded, front-end framework like Bootstrap. Here's some brief examples of how to accomplish what I think you are referring to above. Slideshows See Flare's ...


2

The only reason to use figure titles if they already have a caption is to refer to multiple figures throughout the text, particularly if each one has multiple panels. If so, they should merely say Fig. 1 A, for example. Take a look at any scientific article for examples of this, here's one for starters. As for your example, I don't think you really need ...



Top 50 recent answers are included