: Referencing Screen shots in technical/knowledge base articles? when writing knowledge base articles to support software users - is it ok to reference the screenshots I am using with the term "Figure"?

when writing knowledge base articles to support software users - is it ok to reference the screenshots I am using with the term "Figure"? For example, using '(See figure 1)' in the body text when figure 1 is a screen shot on page? Are there other terms/standards that should be used?

Load Full (1)

: To elicit emotions, you have to have emotions. That is actually a problem for some people; they (by nature or upbringing or both) remain analytical or cynical about most things. They don't

@Mendez196

Load Full 0 Comments

: "I smiled. I ate. I spoke. I listened. I left." If you are going to write from a depressed point of view, I don't think these are the thoughts of a depressed person. For a depressed

@Mendez196

Load Full 0 Comments

: Doing walls of text dialogue right Shakespeare did it, he did it quite a lot of times, but there are a few problems with it: He was a screenwriter in an age, where we couldn't afford building

@Mendez196

Load Full 3 Comments

: Flash-forward as Prologue and then Flashbacks too complicated? Chronologically, the story begins with the protagonist as a child and description of her world, which is important to the plot. Since

@Mendez196

Load Full 3 Comments

Login to post a comment!

1 Comments

Sorted by latest first Latest Oldest Best

@Vandalay250

"See figure x" or "Figure x" is the usual way of doing it, or just "(fig.x)". It's perfectly fine as long as the captions on the figures match the references in the text.

If the screenshots are of your own software this is a nice way of doing it, but watch out for third party software that might change or differences in the way different operating systems display things.

(Users' manuals displaying recognisable W98 windows looked old very quickly.)

Online, you might have the option of a hyperlink, too.

Load Full (0)

Feed

: Referencing Screen shots in technical/knowledge base articles? when writing knowledge base articles to support software users - is it ok to reference the screenshots I am using with the term "Figure"?

More posts by @Mendez196

: To elicit emotions, you have to have emotions. That is actually a problem for some people; they (by nature or upbringing or both) remain analytical or cynical about most things. They don't

: "I smiled. I ate. I spoke. I listened. I left." If you are going to write from a depressed point of view, I don't think these are the thoughts of a depressed person. For a depressed

: Doing walls of text dialogue right Shakespeare did it, he did it quite a lot of times, but there are a few problems with it: He was a screenwriter in an age, where we couldn't afford building

: Flash-forward as Prologue and then Flashbacks too complicated? Chronologically, the story begins with the protagonist as a child and description of her world, which is important to the plot. Since

Login to post a comment!

1 Comments

Back to top