Plain language with long required phrases The 2019 Stack Overflow Developer Survey Results Are InIs it good style to use latin phrases in english scientific literature?What counts as a word when dealing with a word limit?Are there books to improve the style?Condensing words, to condense or not?How can I stress a certain word in a medium that doesn't allow for font embellishments?Can basic grammar rules be skipped when writing text for machine safety labels?How to structure the text when describing the steps of a procedure which has simultaneous processes?Structuring a sentence with two phrases qualifying the same endingHow can I make my roleplay sentences more interesting, and less lengthy?Is it okay to use “fell” in one sentence, and “fall” in the next sentence?

JSON.serialize: is it possible to suppress null values of a map?

How can I create a character who can assume the widest possible range of creature sizes?

What tool would a Roman-age civilization have to grind silver and other metals into dust?

How to reverse every other sublist of a list?

How to deal with fear of taking dependencies

What is the use of option -o in the useradd command?

What does "rabbited" mean/imply in this sentence?

Inflated grade on resume at previous job, might former employer tell new employer?

If the Wish spell is used to duplicate the effect of Simulacrum, are existing duplicates destroyed?

What could be the right powersource for 15 seconds lifespan disposable giant chainsaw?

Does light intensity oscillate really fast since it is a wave?

What do the Banks children have against barley water?

Patience, young "Padovan"

I looked up a future colleague on LinkedIn before I started a job. I told my colleague about it and he seemed surprised. Should I apologize?

Landlord wants to switch my lease to a "Land contract" to "get back at the city"

A poker game description that does not feel gimmicky

Is bread bad for ducks?

Are there any other methods to apply to solving simultaneous equations?

Geography at the pixel level

Realistic Alternatives to Dust: What Else Could Feed a Plankton Bloom?

How to answer pointed "are you quitting" questioning when I don't want them to suspect

Why don't Unix/Linux systems traverse through directories until they find the required version of a linked library?

aging parents with no investments

What is this 4-propeller plane?



Plain language with long required phrases



The 2019 Stack Overflow Developer Survey Results Are InIs it good style to use latin phrases in english scientific literature?What counts as a word when dealing with a word limit?Are there books to improve the style?Condensing words, to condense or not?How can I stress a certain word in a medium that doesn't allow for font embellishments?Can basic grammar rules be skipped when writing text for machine safety labels?How to structure the text when describing the steps of a procedure which has simultaneous processes?Structuring a sentence with two phrases qualifying the same endingHow can I make my roleplay sentences more interesting, and less lengthy?Is it okay to use “fell” in one sentence, and “fall” in the next sentence?










8















I am trying to create documentation for an application, and it's for end users who use keyboard (not mouse) and a screen reader.



Some of our conventions require us to always use the full phrase as listed on screen: if we're talking about the category combo box, but the label says "Please pick a Category:" [sic], that's what we have to use.



Another convention is for keyboard shortcuts -- they are always several "words" long, as we use white space (or I go non-breaking-space) between each element of it. So we have CTRL + INSERT + T for tables list.



So as you may have noticed, I have a tendency towards long sentences with many clauses. I'm using Hemingway to check each section for Plain Language, and I'm trying to revise the hard/very hard sentences.



The problem is, my sentences are often very long and it's not my fault!



If I replace a multi-word phrase whether keyboard shortcut or on-screen label with "xx," that usually brings the sentence's word count down that the sentences "pass."



Is this "cheating?" Are these "terms of art" and it's ok to say "Ctrl + INSert + number pad 6" is understood as a "word?"



Should only the keyboard shortcuts count as 1-word, as the users may know them from other uses of the screenreader, (so replacing them mentally with "X" for a plainLang check is ok), but "envelope Send Email checkbox" still has to count as 4 words, as they would be new to the user? Or only the first-usage within a section?



Note: My workplace doesn't allow the use of 2nd person, despite PlainLang encouraging personal pronouns -- I'm already "wasting" words by having to always say "the user" instead of "you."



I'd like to know if other technical writers have a consensus on how to handle these conflicts.










share|improve this question






















  • Lot's of questions here… Is it possible to use inferred 2nd person, where "you/the user" is just skipped?

    – wetcircuit
    Apr 4 at 14:12











  • Yes, I do use a lot of that. "Press insert+f5, navigate with down arrows to the most accurate option, then press enter to activate it."

    – April
    Apr 4 at 14:42











  • yeesh, that is a long sentence… And this is necessary every time?

    – wetcircuit
    Apr 4 at 15:18











  • You might try tricking the software by replacing the spaces in those phrases with some special character you don't normally use; like '^', which you can do a global replace on later with a space (or non-breaking space). So "CTRL^+^INSERT^+^T", and maybe Hemingway will count it as a single word.

    – Amadeus
    Apr 4 at 15:39






  • 1





    I wonder if there are conventions specific to screen-readers that should factor into this. This question would benefit from input from somebody who regularly uses a screen-reader.

    – Monica Cellio
    Apr 4 at 15:39















8















I am trying to create documentation for an application, and it's for end users who use keyboard (not mouse) and a screen reader.



Some of our conventions require us to always use the full phrase as listed on screen: if we're talking about the category combo box, but the label says "Please pick a Category:" [sic], that's what we have to use.



Another convention is for keyboard shortcuts -- they are always several "words" long, as we use white space (or I go non-breaking-space) between each element of it. So we have CTRL + INSERT + T for tables list.



So as you may have noticed, I have a tendency towards long sentences with many clauses. I'm using Hemingway to check each section for Plain Language, and I'm trying to revise the hard/very hard sentences.



The problem is, my sentences are often very long and it's not my fault!



If I replace a multi-word phrase whether keyboard shortcut or on-screen label with "xx," that usually brings the sentence's word count down that the sentences "pass."



Is this "cheating?" Are these "terms of art" and it's ok to say "Ctrl + INSert + number pad 6" is understood as a "word?"



Should only the keyboard shortcuts count as 1-word, as the users may know them from other uses of the screenreader, (so replacing them mentally with "X" for a plainLang check is ok), but "envelope Send Email checkbox" still has to count as 4 words, as they would be new to the user? Or only the first-usage within a section?



Note: My workplace doesn't allow the use of 2nd person, despite PlainLang encouraging personal pronouns -- I'm already "wasting" words by having to always say "the user" instead of "you."



I'd like to know if other technical writers have a consensus on how to handle these conflicts.










share|improve this question






















  • Lot's of questions here… Is it possible to use inferred 2nd person, where "you/the user" is just skipped?

    – wetcircuit
    Apr 4 at 14:12











  • Yes, I do use a lot of that. "Press insert+f5, navigate with down arrows to the most accurate option, then press enter to activate it."

    – April
    Apr 4 at 14:42











  • yeesh, that is a long sentence… And this is necessary every time?

    – wetcircuit
    Apr 4 at 15:18











  • You might try tricking the software by replacing the spaces in those phrases with some special character you don't normally use; like '^', which you can do a global replace on later with a space (or non-breaking space). So "CTRL^+^INSERT^+^T", and maybe Hemingway will count it as a single word.

    – Amadeus
    Apr 4 at 15:39






  • 1





    I wonder if there are conventions specific to screen-readers that should factor into this. This question would benefit from input from somebody who regularly uses a screen-reader.

    – Monica Cellio
    Apr 4 at 15:39













8












8








8








I am trying to create documentation for an application, and it's for end users who use keyboard (not mouse) and a screen reader.



Some of our conventions require us to always use the full phrase as listed on screen: if we're talking about the category combo box, but the label says "Please pick a Category:" [sic], that's what we have to use.



Another convention is for keyboard shortcuts -- they are always several "words" long, as we use white space (or I go non-breaking-space) between each element of it. So we have CTRL + INSERT + T for tables list.



So as you may have noticed, I have a tendency towards long sentences with many clauses. I'm using Hemingway to check each section for Plain Language, and I'm trying to revise the hard/very hard sentences.



The problem is, my sentences are often very long and it's not my fault!



If I replace a multi-word phrase whether keyboard shortcut or on-screen label with "xx," that usually brings the sentence's word count down that the sentences "pass."



Is this "cheating?" Are these "terms of art" and it's ok to say "Ctrl + INSert + number pad 6" is understood as a "word?"



Should only the keyboard shortcuts count as 1-word, as the users may know them from other uses of the screenreader, (so replacing them mentally with "X" for a plainLang check is ok), but "envelope Send Email checkbox" still has to count as 4 words, as they would be new to the user? Or only the first-usage within a section?



Note: My workplace doesn't allow the use of 2nd person, despite PlainLang encouraging personal pronouns -- I'm already "wasting" words by having to always say "the user" instead of "you."



I'd like to know if other technical writers have a consensus on how to handle these conflicts.










share|improve this question














I am trying to create documentation for an application, and it's for end users who use keyboard (not mouse) and a screen reader.



Some of our conventions require us to always use the full phrase as listed on screen: if we're talking about the category combo box, but the label says "Please pick a Category:" [sic], that's what we have to use.



Another convention is for keyboard shortcuts -- they are always several "words" long, as we use white space (or I go non-breaking-space) between each element of it. So we have CTRL + INSERT + T for tables list.



So as you may have noticed, I have a tendency towards long sentences with many clauses. I'm using Hemingway to check each section for Plain Language, and I'm trying to revise the hard/very hard sentences.



The problem is, my sentences are often very long and it's not my fault!



If I replace a multi-word phrase whether keyboard shortcut or on-screen label with "xx," that usually brings the sentence's word count down that the sentences "pass."



Is this "cheating?" Are these "terms of art" and it's ok to say "Ctrl + INSert + number pad 6" is understood as a "word?"



Should only the keyboard shortcuts count as 1-word, as the users may know them from other uses of the screenreader, (so replacing them mentally with "X" for a plainLang check is ok), but "envelope Send Email checkbox" still has to count as 4 words, as they would be new to the user? Or only the first-usage within a section?



Note: My workplace doesn't allow the use of 2nd person, despite PlainLang encouraging personal pronouns -- I'm already "wasting" words by having to always say "the user" instead of "you."



I'd like to know if other technical writers have a consensus on how to handle these conflicts.







style technical-writing non-fiction






share|improve this question













share|improve this question











share|improve this question




share|improve this question










asked Apr 4 at 14:07









AprilApril

2,273636




2,273636












  • Lot's of questions here… Is it possible to use inferred 2nd person, where "you/the user" is just skipped?

    – wetcircuit
    Apr 4 at 14:12











  • Yes, I do use a lot of that. "Press insert+f5, navigate with down arrows to the most accurate option, then press enter to activate it."

    – April
    Apr 4 at 14:42











  • yeesh, that is a long sentence… And this is necessary every time?

    – wetcircuit
    Apr 4 at 15:18











  • You might try tricking the software by replacing the spaces in those phrases with some special character you don't normally use; like '^', which you can do a global replace on later with a space (or non-breaking space). So "CTRL^+^INSERT^+^T", and maybe Hemingway will count it as a single word.

    – Amadeus
    Apr 4 at 15:39






  • 1





    I wonder if there are conventions specific to screen-readers that should factor into this. This question would benefit from input from somebody who regularly uses a screen-reader.

    – Monica Cellio
    Apr 4 at 15:39

















  • Lot's of questions here… Is it possible to use inferred 2nd person, where "you/the user" is just skipped?

    – wetcircuit
    Apr 4 at 14:12











  • Yes, I do use a lot of that. "Press insert+f5, navigate with down arrows to the most accurate option, then press enter to activate it."

    – April
    Apr 4 at 14:42











  • yeesh, that is a long sentence… And this is necessary every time?

    – wetcircuit
    Apr 4 at 15:18











  • You might try tricking the software by replacing the spaces in those phrases with some special character you don't normally use; like '^', which you can do a global replace on later with a space (or non-breaking space). So "CTRL^+^INSERT^+^T", and maybe Hemingway will count it as a single word.

    – Amadeus
    Apr 4 at 15:39






  • 1





    I wonder if there are conventions specific to screen-readers that should factor into this. This question would benefit from input from somebody who regularly uses a screen-reader.

    – Monica Cellio
    Apr 4 at 15:39
















Lot's of questions here… Is it possible to use inferred 2nd person, where "you/the user" is just skipped?

– wetcircuit
Apr 4 at 14:12





Lot's of questions here… Is it possible to use inferred 2nd person, where "you/the user" is just skipped?

– wetcircuit
Apr 4 at 14:12













Yes, I do use a lot of that. "Press insert+f5, navigate with down arrows to the most accurate option, then press enter to activate it."

– April
Apr 4 at 14:42





Yes, I do use a lot of that. "Press insert+f5, navigate with down arrows to the most accurate option, then press enter to activate it."

– April
Apr 4 at 14:42













yeesh, that is a long sentence… And this is necessary every time?

– wetcircuit
Apr 4 at 15:18





yeesh, that is a long sentence… And this is necessary every time?

– wetcircuit
Apr 4 at 15:18













You might try tricking the software by replacing the spaces in those phrases with some special character you don't normally use; like '^', which you can do a global replace on later with a space (or non-breaking space). So "CTRL^+^INSERT^+^T", and maybe Hemingway will count it as a single word.

– Amadeus
Apr 4 at 15:39





You might try tricking the software by replacing the spaces in those phrases with some special character you don't normally use; like '^', which you can do a global replace on later with a space (or non-breaking space). So "CTRL^+^INSERT^+^T", and maybe Hemingway will count it as a single word.

– Amadeus
Apr 4 at 15:39




1




1





I wonder if there are conventions specific to screen-readers that should factor into this. This question would benefit from input from somebody who regularly uses a screen-reader.

– Monica Cellio
Apr 4 at 15:39





I wonder if there are conventions specific to screen-readers that should factor into this. This question would benefit from input from somebody who regularly uses a screen-reader.

– Monica Cellio
Apr 4 at 15:39










1 Answer
1






active

oldest

votes


















8














It's possible you're tying yourself in knots with Hemingway which is, perhaps, better for prose writers than technical writers.



Hemingway themselves state:




But what if I want to break the rules?



Rules are meant to be broken. If you know what you're doing, don't let
us stop you. View our suggestions as just that.




I used to write instructional manuals for IBM and Sun Microsystems. For new users, I'd try to emulate the formatting of a Dummies book. Word 2007 for Dummies has a Look Inside for you to see how they handle it.



If you aren't constrained by company formatting, try splitting out the processes with a quick explanation, followed by a numbered list of commands, with the clicks and keyboard strokes in bold, and explanations unbolded. Like this:



IMPORTING A PICTURE INTO A MS WORD DOCUMENT



Importing pictures into Word is very easy, just take the following steps:



  1. Left click the INSERT menu option. A pop up menu appears.


  2. From the pop up menu, select PICTURES. A side menu appears.


  3. From the side menu, select PICTURE FROM FILE.


Stripping each method into numbered lists avoids long, complex sentences with commands embedded in the middle. Of short sentences like this, Hemingway should approve.



I've used mouse clicks in this example, which you would just switch out for keyboard commands. I didn't know the keyboard commands for this example!



HTH, but difficult to advise better when I don't know all the rules you have to abide by.






share|improve this answer























  • No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

    – April
    Apr 4 at 19:17






  • 1





    Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

    – GGx
    Apr 4 at 19:19







  • 1





    It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

    – April
    Apr 4 at 19:24











  • @April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

    – GGx
    Apr 5 at 12:51











  • I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

    – April
    Apr 5 at 13:10











Your Answer








StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "166"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
noCode: true, onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);













draft saved

draft discarded


















StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fwriting.stackexchange.com%2fquestions%2f44362%2fplain-language-with-long-required-phrases%23new-answer', 'question_page');

);

Post as a guest















Required, but never shown

























1 Answer
1






active

oldest

votes








1 Answer
1






active

oldest

votes









active

oldest

votes






active

oldest

votes









8














It's possible you're tying yourself in knots with Hemingway which is, perhaps, better for prose writers than technical writers.



Hemingway themselves state:




But what if I want to break the rules?



Rules are meant to be broken. If you know what you're doing, don't let
us stop you. View our suggestions as just that.




I used to write instructional manuals for IBM and Sun Microsystems. For new users, I'd try to emulate the formatting of a Dummies book. Word 2007 for Dummies has a Look Inside for you to see how they handle it.



If you aren't constrained by company formatting, try splitting out the processes with a quick explanation, followed by a numbered list of commands, with the clicks and keyboard strokes in bold, and explanations unbolded. Like this:



IMPORTING A PICTURE INTO A MS WORD DOCUMENT



Importing pictures into Word is very easy, just take the following steps:



  1. Left click the INSERT menu option. A pop up menu appears.


  2. From the pop up menu, select PICTURES. A side menu appears.


  3. From the side menu, select PICTURE FROM FILE.


Stripping each method into numbered lists avoids long, complex sentences with commands embedded in the middle. Of short sentences like this, Hemingway should approve.



I've used mouse clicks in this example, which you would just switch out for keyboard commands. I didn't know the keyboard commands for this example!



HTH, but difficult to advise better when I don't know all the rules you have to abide by.






share|improve this answer























  • No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

    – April
    Apr 4 at 19:17






  • 1





    Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

    – GGx
    Apr 4 at 19:19







  • 1





    It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

    – April
    Apr 4 at 19:24











  • @April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

    – GGx
    Apr 5 at 12:51











  • I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

    – April
    Apr 5 at 13:10















8














It's possible you're tying yourself in knots with Hemingway which is, perhaps, better for prose writers than technical writers.



Hemingway themselves state:




But what if I want to break the rules?



Rules are meant to be broken. If you know what you're doing, don't let
us stop you. View our suggestions as just that.




I used to write instructional manuals for IBM and Sun Microsystems. For new users, I'd try to emulate the formatting of a Dummies book. Word 2007 for Dummies has a Look Inside for you to see how they handle it.



If you aren't constrained by company formatting, try splitting out the processes with a quick explanation, followed by a numbered list of commands, with the clicks and keyboard strokes in bold, and explanations unbolded. Like this:



IMPORTING A PICTURE INTO A MS WORD DOCUMENT



Importing pictures into Word is very easy, just take the following steps:



  1. Left click the INSERT menu option. A pop up menu appears.


  2. From the pop up menu, select PICTURES. A side menu appears.


  3. From the side menu, select PICTURE FROM FILE.


Stripping each method into numbered lists avoids long, complex sentences with commands embedded in the middle. Of short sentences like this, Hemingway should approve.



I've used mouse clicks in this example, which you would just switch out for keyboard commands. I didn't know the keyboard commands for this example!



HTH, but difficult to advise better when I don't know all the rules you have to abide by.






share|improve this answer























  • No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

    – April
    Apr 4 at 19:17






  • 1





    Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

    – GGx
    Apr 4 at 19:19







  • 1





    It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

    – April
    Apr 4 at 19:24











  • @April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

    – GGx
    Apr 5 at 12:51











  • I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

    – April
    Apr 5 at 13:10













8












8








8







It's possible you're tying yourself in knots with Hemingway which is, perhaps, better for prose writers than technical writers.



Hemingway themselves state:




But what if I want to break the rules?



Rules are meant to be broken. If you know what you're doing, don't let
us stop you. View our suggestions as just that.




I used to write instructional manuals for IBM and Sun Microsystems. For new users, I'd try to emulate the formatting of a Dummies book. Word 2007 for Dummies has a Look Inside for you to see how they handle it.



If you aren't constrained by company formatting, try splitting out the processes with a quick explanation, followed by a numbered list of commands, with the clicks and keyboard strokes in bold, and explanations unbolded. Like this:



IMPORTING A PICTURE INTO A MS WORD DOCUMENT



Importing pictures into Word is very easy, just take the following steps:



  1. Left click the INSERT menu option. A pop up menu appears.


  2. From the pop up menu, select PICTURES. A side menu appears.


  3. From the side menu, select PICTURE FROM FILE.


Stripping each method into numbered lists avoids long, complex sentences with commands embedded in the middle. Of short sentences like this, Hemingway should approve.



I've used mouse clicks in this example, which you would just switch out for keyboard commands. I didn't know the keyboard commands for this example!



HTH, but difficult to advise better when I don't know all the rules you have to abide by.






share|improve this answer













It's possible you're tying yourself in knots with Hemingway which is, perhaps, better for prose writers than technical writers.



Hemingway themselves state:




But what if I want to break the rules?



Rules are meant to be broken. If you know what you're doing, don't let
us stop you. View our suggestions as just that.




I used to write instructional manuals for IBM and Sun Microsystems. For new users, I'd try to emulate the formatting of a Dummies book. Word 2007 for Dummies has a Look Inside for you to see how they handle it.



If you aren't constrained by company formatting, try splitting out the processes with a quick explanation, followed by a numbered list of commands, with the clicks and keyboard strokes in bold, and explanations unbolded. Like this:



IMPORTING A PICTURE INTO A MS WORD DOCUMENT



Importing pictures into Word is very easy, just take the following steps:



  1. Left click the INSERT menu option. A pop up menu appears.


  2. From the pop up menu, select PICTURES. A side menu appears.


  3. From the side menu, select PICTURE FROM FILE.


Stripping each method into numbered lists avoids long, complex sentences with commands embedded in the middle. Of short sentences like this, Hemingway should approve.



I've used mouse clicks in this example, which you would just switch out for keyboard commands. I didn't know the keyboard commands for this example!



HTH, but difficult to advise better when I don't know all the rules you have to abide by.







share|improve this answer












share|improve this answer



share|improve this answer










answered Apr 4 at 17:06









GGxGGx

6,78311343




6,78311343












  • No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

    – April
    Apr 4 at 19:17






  • 1





    Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

    – GGx
    Apr 4 at 19:19







  • 1





    It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

    – April
    Apr 4 at 19:24











  • @April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

    – GGx
    Apr 5 at 12:51











  • I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

    – April
    Apr 5 at 13:10

















  • No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

    – April
    Apr 4 at 19:17






  • 1





    Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

    – GGx
    Apr 4 at 19:19







  • 1





    It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

    – April
    Apr 4 at 19:24











  • @April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

    – GGx
    Apr 5 at 12:51











  • I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

    – April
    Apr 5 at 13:10
















No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

– April
Apr 4 at 19:17





No pictures -- these users are visually impaired. Things are already numbered and as short as I can make them.

– April
Apr 4 at 19:17




1




1





Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

– GGx
Apr 4 at 19:19






Then is it possible you've already done a great job and Hemingway is making you doubt your own skills?

– GGx
Apr 4 at 19:19





1




1





It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

– April
Apr 4 at 19:24





It may be. I haven't done a tech document before (though I've taught tech writing), and I've never had so much time to proofread/edit the heck out of something. As an instructor, it was write&go (assignment sheets) , or give a few tips in student feedback. We don't have much collaboration in this office, which is partly what I was hoping for.

– April
Apr 4 at 19:24













@April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

– GGx
Apr 5 at 12:51





@April is there really no-one in your office who could check your work and make sure you are heading in the right direction? If you have already formatted it in this way, as simple as a Dummies book, while following the company guidelines, I would say you have done your job. The only way to know for sure is to hand it over and get feedback. But it does sound to me like you may be overthinking and overanalysing it with tools like Hemingway. It's just a tool to help you, not to be followed blindly. Perhaps drop a comment on here and let us know if they were happy with it! Good luck.

– GGx
Apr 5 at 12:51













I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

– April
Apr 5 at 13:10





I did a read-aloud edit, so I found some errors (some formatting, some were misphrasings), but later today I'll declare it "done." I've met with one co-writer a little, but she has her own projects. She told me that first draft wasn't what I'd call a first draft, but it should be "as complete/correct as possible." (Partially I asked this question due to the tag-of-the-week question drive, not pure anxiety)

– April
Apr 5 at 13:10

















draft saved

draft discarded
















































Thanks for contributing an answer to Writing Stack Exchange!


  • Please be sure to answer the question. Provide details and share your research!

But avoid


  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.

To learn more, see our tips on writing great answers.




draft saved


draft discarded














StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fwriting.stackexchange.com%2fquestions%2f44362%2fplain-language-with-long-required-phrases%23new-answer', 'question_page');

);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

រឿង រ៉ូមេអូ និង ហ្ស៊ុយលីយេ សង្ខេបរឿង តួអង្គ បញ្ជីណែនាំ

Crop image to path created in TikZ? Announcing the arrival of Valued Associate #679: Cesar Manara Planned maintenance scheduled April 17/18, 2019 at 00:00UTC (8:00pm US/Eastern)Crop an inserted image?TikZ pictures does not appear in posterImage behind and beyond crop marks?Tikz picture as large as possible on A4 PageTransparency vs image compression dilemmaHow to crop background from image automatically?Image does not cropTikzexternal capturing crop marks when externalizing pgfplots?How to include image path that contains a dollar signCrop image with left size given

Romeo and Juliet ContentsCharactersSynopsisSourcesDate and textThemes and motifsCriticism and interpretationLegacyScene by sceneSee alsoNotes and referencesSourcesExternal linksNavigation menu"Consumer Price Index (estimate) 1800–"10.2307/28710160037-3222287101610.1093/res/II.5.31910.2307/45967845967810.2307/2869925286992510.1525/jams.1982.35.3.03a00050"Dada Masilo: South African dancer who breaks the rules"10.1093/res/os-XV.57.1610.2307/28680942868094"Sweet Sorrow: Mann-Korman's Romeo and Juliet Closes Sept. 5 at MN's Ordway"the original10.2307/45957745957710.1017/CCOL0521570476.009"Ram Leela box office collections hit massive Rs 100 crore, pulverises prediction"Archived"Broadway Revival of Romeo and Juliet, Starring Orlando Bloom and Condola Rashad, Will Close Dec. 8"Archived10.1075/jhp.7.1.04hon"Wherefore art thou, Romeo? To make us laugh at Navy Pier"the original10.1093/gmo/9781561592630.article.O006772"Ram-leela Review Roundup: Critics Hail Film as Best Adaptation of Romeo and Juliet"Archived10.2307/31946310047-77293194631"Romeo and Juliet get Twitter treatment""Juliet's Nurse by Lois Leveen""Romeo and Juliet: Orlando Bloom's Broadway Debut Released in Theaters for Valentine's Day"Archived"Romeo and Juliet Has No Balcony"10.1093/gmo/9781561592630.article.O00778110.2307/2867423286742310.1076/enst.82.2.115.959510.1080/00138380601042675"A plague o' both your houses: error in GCSE exam paper forces apology""Juliet of the Five O'Clock Shadow, and Other Wonders"10.2307/33912430027-4321339124310.2307/28487440038-7134284874410.2307/29123140149-661129123144728341M"Weekender Guide: Shakespeare on The Drive""balcony"UK public library membership"romeo"UK public library membership10.1017/CCOL9780521844291"Post-Zionist Critique on Israel and the Palestinians Part III: Popular Culture"10.2307/25379071533-86140377-919X2537907"Capulets and Montagues: UK exam board admit mixing names up in Romeo and Juliet paper"Istoria Novellamente Ritrovata di Due Nobili Amanti2027/mdp.390150822329610820-750X"GCSE exam error: Board accidentally rewrites Shakespeare"10.2307/29176390149-66112917639"Exam board apologises after error in English GCSE paper which confused characters in Shakespeare's Romeo and Juliet""From Mariotto and Ganozza to Romeo and Guilietta: Metamorphoses of a Renaissance Tale"10.2307/37323537323510.2307/2867455286745510.2307/28678912867891"10 Questions for Taylor Swift"10.2307/28680922868092"Haymarket Theatre""The Zeffirelli Way: Revealing Talk by Florentine Director""Michael Smuin: 1938-2007 / Prolific dance director had showy career"The Life and Art of Edwin BoothRomeo and JulietRomeo and JulietRomeo and JulietRomeo and JulietEasy Read Romeo and JulietRomeo and Julieteeecb12003684p(data)4099369-3n8211610759dbe00d-a9e2-41a3-b2c1-977dd692899302814385X313670221313670221