I'm documenting a web application where the only way to exist is to exit the active browser window (tab?) in which the app is running.
Which is better terminology?
"To exit this …
I'm writing a user manual with step-by-step actions and I'm looking for a web site or blog or pdf that has best practices for using colors in callouts, documenting keyboard mouse actions, etc.
I need to include a screenshot of a table that's displayed in a web app. This table contains (e.g.) one row for each day YTD, so, currently, it would be over 100 rows. I don't want to include …
In a document, I'm showing the reader how to navigate to a particular screen "Add Users". Per existing style, (which I've inherited), I need to write something like:
User Portal --> Internal …
Can someone point me to guidelines to be used for people who suffer from color blindness.
Colors and/or shades and/or shapes to avoid.
I am documenting a screen which supports a series of options (e.g. filter, sort, search, expand-a-field) that control the display of the data rows. Other options allow you do edit or …
In the following sentence:
"This product is currently in Beta ,and will be released to all customers in March."
Am I correct in capitalizing "Beta"?
Forgive the obtuse title. I'm trying to explain to users that they need to enter a code that can be 8 or 10 digits. Is the following correct?
"Enter the 8- or 10-digit activation …
I had this question after viewing Writing numbers of 1000 or more with decimals in technical documentation …
In writing technical documentation (in this case an API guide:
If I need to write the number 1000, I like to write as 1,000
However, if I need to write 1000.0 or 1000.1, is the comma still …
For the following sentence, which of the below is correct?
"You need write access to your CD-ROM drive to take advantage of this feature..."
"You need write access on your CD-ROM …
Is there any template or Software to write user guide for a software.
I'm writing a user-facing document that instructs the reader to click the icon below. Is there a standard name for it?
Whether you're looking for first tech job or your hundredth job, the process can feel like a long, hard struggle. It can be made easier with the help of a good resume.
I would like to have below clarification regarding the course before I proceed further to enroll.
If for some personal reasons, If I want to to give a pause to the course enrolled for …
All technical issues from server side has been resolved(like Memory, File system level bankup … …etc.)
Apparently environment is stable now.
this is to inform you that, The only task …
Until today I am under the assumption that, Row over this matter concluded long before. After getting your call yesterday, understand apparently it was not true.
A month before, when you whatsup…
My company is looking at instituting a policy in which that if they pay to send you to technical or any type of certification training, that the cost of that would be recoverable …
The following "thingy" (trying to use a general term here :) ), is part of a web application...it is just one portion of a screen with many components.
What would you call it in …
When I write formal technical documentation, I tend to avoid contractions (e.g. you're) per "best practices". However, I'm writing a text box for a screen shot where "real estate" is at a premium. :) …
I'm documenting a web application in which one can "hover" over (with the mouse pointer) an on-screen field to display more info. What is the most-accepted terminology that most/all …
I have a feeling there may be multiple opinions on this one, but looking for some feedback.
I am documenting a web app that contains numerous forms to fill out. To guide the …
I'm importing a Word doc into my company's Wiki, in Confluence. Unfortunately, the Confluence "Office Connector" has several documented issues (and one I noticed that is not documented) that …
I am documenting a Web app which includes the following screen. (Redacted significantly.) I am looking for the correct term to use when referring to the left-hand portion of the screen? Pane? Panel? …
In the document suite I am maintaining/adding to, I'm using boldface text to indicate user input on a field e.g.
1) Enter $1.00
Semantic issue: I'm thinking I should NOT end …