Some in-app copyediting

Issue #639 new
Federico Hernandez Nater created an issue

Below are some typos I’ve found in writing our Case Study, things which must have slipped through in the MDS 4 copyedit. I’ve combined some previous issues along with newer copyedits for this larger enhancement submission:

Workflow Editor

Variable Editor

Add a title for the variable editor (e.g., Edit Variable, Variable Editor, etc.)

Typos in the description are fixed below

Copyedited description:

The dialog displayed that prompts for a value consists of two parts: the Prompt Title and the Type. The Prompt Title is shown to the user; the Type is how they provide the information (text or pop-up). Pop-ups can include an “Other…” option for entries not available in the pop-up.

Resources

In the description, it may be beneficial to shorten the last parenthetical:

Select folders below to install Packages, Apps, Scripts, and Profiles. The items in the specified folders will be packaged up (as needed) and installed after macOS (or immediately if macOS has not been selected to install).

It’s correct, but shortening it would look like:

Select folders below to install Packages, Apps, Scripts, and Profiles. The items in the specified folders will be packaged up (as needed) and installed after macOS (immediately if not installing macOS).

For the checked options “Specify a folder containing macOS packages and apps to install on the target Mac.” and “Specify a folder containing scripts to run on the target Mac.”, I’d recommend removing the periods that end them. Though technically acceptable to add a period at the end of a longer phrase, it would stylistically make sense to remove them to maintain the parallel structure of the text in the other Workflow Editor tabs.

This would change the phrases to:

  • Specify a folder containing macOS packages and apps to install on the target Mac
  • Specify a folder containing scripts to run on the target Mac

I’d also recommend removing the spaces around the slash & making “First Boot” lowercase in “Reboot after installing / running First Boot resources (if any)”.

This would change it to:

Reboot after installing/running first boot resources (if any)

Options

Just one quick fix here: add a hyphen to “WiFi” making it “Wi-Fi”

Munki

Another quick fix: add a comma to the parenthetical in the description:

(and in many cases removals) → (and in many cases, removals)

Main Window

Tools

Create Bootable Installer

To provide some clarity, I’d change the sentence above to:

To make the external volume bootable, select both macOS Installer app and target volume. Then, click Create.

Services

A few copyedits here, here is the description with copyedits:

Web Service is Web Service is used to host services, such as Munki and MunkiReport, and is based on the open-source Apache HTTP Server. Additional static websites and static apps can also be specified.

Preferences

Packages

Packages can be signed with a Developer ID certificate from Apple or other certificate trusted by the clients.

Packages can be signed with either a Developer ID certificate from Apple or a certificate trusted by the clients.

Deployment

Workflows

Within the “Workflow Options” subsection, the checkboxes at the top seem close enough where one could confuse which checkbox was for which option:

I’d recommend modifying the format to add some space between the two; alternatively, you could attempt ending the first option with some additional spaces.

Also, within the same subsection, capitalize “workflow” or “workflows” in each option (i.e., Connect to Wi-Fi before showing workflows, Check for network before showing workflows, Automatically run workflow with name).

Tools

Create Bootable Installer

To provide some clarity, I’d change the sentence above to:

“To make the external volume bootable, select both macOS Installer app and target volume. Then, click Create.”

Comments (5)

  1. Log in to comment