Skip to content

Conversation

@julian-cable
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@daobrien daobrien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly ok but a few things need updating.

<listitem>
<para>
DRaaS (Disaster Recovery-as-a-Service)
AIaaS (Artificial Intelligence-as-a-Service)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This actually contradicts the previous para: "When spelling it out, do not capitalize the term". You might like to update that para to include "unless part of a proper noun" or similar.

We also do not need all these examples of aaS terms. We need basic guidance and a list of any exceptions, and that's all. Otherwise this list is going to get very long over time.

en-US/A.xml Outdated
<listitem>
<para>
Avoid use of an acronym if it could stand for more than one term in a single asset. for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service.
Avoid using an acronym if it could stand for more than one term in a single asset, for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Avoid using an acronym if it could stand for more than one term in a single asset, for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service.
Avoid using an acronym if it could stand for more than one term in a single asset. For example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service.

The original version was more correct IMO.

en-US/Design.xml Outdated
<title>Writing Effective Titles</title>
<para>
Use a title that represents the content.
Use a title that represents the content.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I prefer "Use titles that represent..." but that's just me.

en-US/Design.xml Outdated
</para>
<para>
Avoid a title that consists of only one word.
Avoid a title that consists of only one word.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above.

en-US/Design.xml Outdated
<para>
Do not use manual line indentation for the second and subsequent lines of commands.
For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places.
For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/inelegant/awkward/

en-US/Design.xml Outdated
<title>Omitting Part of Output</title>
<para>
For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described.
For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described.
For the sake of brevity, do not show all output to the user in all cases.
Instead, show only those parts of any output that are relevant to the context that is described.

<row>
<entry> The system menu allows you to switch network and VPN connections on or off. </entry>
<entry> From the system menu, you can switch network and VPN connections on or off. </entry>
<entry> The <guibutton>system</guibutton> menu allows you to switch network and VPN connections on or off. </entry>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you be using <guimenu>?

<entry> The system menu allows you to switch network and VPN connections on or off. </entry>
<entry> From the system menu, you can switch network and VPN connections on or off. </entry>
<entry> The <guibutton>system</guibutton> menu allows you to switch network and VPN connections on or off. </entry>
<entry> From the <guibutton>system</guibutton> menu, you can switch network and VPN connections on or off. </entry>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants