Hello,

Since I'm not familiar with the MAC, (in fact, I don't have access to one) I have not encountered this syntax before.

In a set of Release Notes, I need to document a feature involving the MAC key combination COMMAND and Click.  Two questions:

1. What's the preferred syntax here?

<Command>-<Click>
<Cmd>-<Click>
Something else?

2. What's the correct verb? Press? Perform? Do? e.g.
Press <Command>-<Click>


Thanks,
Steve

Hello,

To indicate an optional plural, I would write:

Select the checkbox(es) next to the item(s)

But, how about for a word such as "category".

Do I write:

Select the checkbox(es) next to the category(s)

(or)
Select the checkbox(es) next to the categor(ies)

While I suppose this sentence could be rewritten, all I"m looking for is the specific issue of (s) vs (ies).

Thank(s) :)

I had this question after viewing I need a synonym for the word "field" (Database context).

I'm documenting a web application screen that contains numerous fields per this redacted example for running (race) data for an athlete.

Date: 02/09/18
Race Name: Experts Exchange Challenge
Distance: 5 miles

Result:   Time: 39:09   PacePerMile: 7:50

Date, Race Name, and Distance are fields.

But how about Result and its elements (Time and PacePerMile)?  I'm calling Result a "field" and it elements "subfields".  Am I on safe ground? (My audience is technical people such as UX designers.)

Thanks!

Hi,

Suppose (redacted example) I have an application to measure running statistics.

First field (UNITS) is a drop-down menu with the choices (MILES, KILOMETERS, OTHER)
The subsequent fields are determined by the first field.
If UNITS = MILES,:
    One field (Mi.) displays, with numeric input.
If UNITS = KILOMETERS
    One field (Km.) displays, with numeric input.
If UNITS = OTHER
    Two fields display:
        CUSTOM UNIT (text field to enter whatever you want (e.g. meters, furlongs, etc.)
        DISTANCE (where you enter a numeric value e.g. 3 for 3 furlongs).

Is it correct to say that there's a field dependency between the subsequent fields and UNITS? I've heard of that term used if a field's available values depend on some other field

http://www.salesforcetutorial.com/field-dependency-in-salesforce/

but how about in this case? (I'm not using Salesforce, my friend Google found it. :) )

Thanks,
Steve

Hi,
I'm documenting a screen in a web application that contains multiple fields. I need to specify the "type" for each one (e.g. text). What would you call a field where you can check one or more checkboxes? Selection List?

Thanks!
Steve

Hi,

In a web app, I've encountered an icon that looks like that below. Is it called a balloon? Something else?

Thanks.

Hey Everyone,

Maybe I'm jumping at shadows after a busy week so far... :)

I encountered the following in something I'm reviewing (redacted)
"This field displays the overall average for all vendors."

But isn't "average" by definition, imply "overall"? I'm thinking I should remove "overall".

Thanks,
Steve

Win10:

Happy Holidays!

Silly question:

What's the term for the Windows button I've highlighted below?


There's Maximize:

()

minimize, close, and this doo-hickey. I've seen it referred to as "restore" on the drop-down menu at the upper-left of the screen. But, is it correct to say,

"When you restore a window to its default size, the data displays yada yada yada..."

Thanks!

Hi,

From what I know, if you are documenting a data structure (e.g. JSON) with embedded objects, you might have something like this for the data schema tables:

DISCLAIMER: In the real world, I doubt you'd have a full (e.g.) doctor object embedded in the prescription object. More likely, you'd have a record number for patient, doctor, drug, but the below is useful for this example. :)

PRESCRIPTION OBJECT
Date
Time
Rx Number
Patient Object
Doctor Object
Drug Object
Directions
etc.


You'd then have tables for the aforementioned objects, which themselves could contain objects:
DOCTOR OBJECT
LastName
FirstName
IdNumbers Object
Address
etc.

And in turn...
ID NUMBERS OBJECT
Licence
DEA
NPI
-----------
Now, to the question. I'm documenting an API where some of the embedded objects contain only one field/object. To use the above example, something like:

PRESCRIPTION OBJECT (as before: contains many fields/objects)

DOCTOR OBJECT (Contains one object)
IdNumbers Object

ID NUMBERS OBJECT (Contains one field)
License

Per the above, would I be overdoing it to have separate data tables for these objects containing only one field/object? If so, I'd need to find a clean way to embed everything in the parent table.

Thanks!
Steve

What are the rules/guidelines regarding the use of "You",  "I" and other pronouns in writing user manuals and other documentation.
Are there any specific rules for tutorial scripts which will be used by on-screen narrators/talent or tutorial voice over talent?

Hi,

Of the two options below, which is preferable?

1. Page-level settings
2. Page level settings.

I'm leaning toward #1 but could be convinced otherwise. :)

Thanks,
Steve

Hi,
I'm writing an API guide for an application that accepts input - and generates output - in JSON format.

Suppose I have the following (redacted) code:

{
   SSN :  "012-34-5678",
   DOB: "1986-10-27",
   Age: 30,
   name: {
      first: "Daffy",
      last : "Duck"
    },
   Department: "Sales"
}

Select all Open in new window

1. Is this entire entity referred to as a block or object?
2. Same for the name element, which contains first/last name.

Also, is JSON syntax considered closer to Java? Or to JavaScript?  The reason I need to know the latter is that I'm showing code samples in Confluence. While Confluence has a Code Block Macro, it does not come with prepackaged JSON formatting.

Thanks,
Steve

Hi,

After I finish editing an image, I would like to close the file so it's no longer in the editor the next time I invoke it. However, the FILE menu does not contain a CLOSE choice. How, then can I accomplish what I need?

Thanks.