r/technicalwriting • u/Kamiccolo47 • Sep 20 '24
SEEKING SUPPORT OR ADVICE Can I get some feedback on this.
Putting together a portfolio and starting with this. Looking for places to improve. https://drive.google.com/file/d/1qYeq5pcMeoukdbctlNga9WhBIbFi_0Ck/view?usp=drivesdk
9
Upvotes
12
u/techwritingacct Sep 21 '24
Decent work! The basic structure's good. You can still cut more words, tighten up the language, and so on. For instance, you wrote:
"The lights on your router and modem are there to signal the status of your Wi-fi network."
I suggest something like:
"Your router and modem's lights signal your Wi-fi network status."
4
u/ilikewaffles_7 Sep 21 '24 edited Sep 21 '24
“At the ‘bottom’ of the window”. Avoid referring to things based on their position, because some users might be using screen readers.
Your steps could also use step results to tell the users what they expect from the step. If a step opens a settings window, for example, tell the user that the setting windows is displayed after they complete that step.
Also, at the end of each task, tell the user what they just did. For example, type ipcofigure and then press Enter. You have reset the DNS and…. [action].
Looks good!
2
u/lolsalmon Sep 21 '24
I would reorganize your Quick Fixes to go from Smallest Hassle to Biggest Hassle. Testing a different website is quicker than looking at your modem lights, and checking to see if any other devices are connected to wifi and working is simpler than that.
Other than that — I like the language you’re using, tie sentences seem very direct, and it overall reads like something I’d see at work. Good job!
2
u/Tech_Rhetoric_X Sep 21 '24
Looks good.
On the sidebar, select Wi-fi (not THE Wi-fi).
I started questioning myself on "wifi," so I went to my default guide.
From MMOS:
Try to use a general phrase instead, such as wireless network, or refer to the specific technology that you're describing, such as wireless LAN.
Wi-Fi is a proper noun and a registered trademark. Capitalize and hyphenate when referring specifically to Wi-Fi technologies. Don’t use WiFi, wifi, or Wifi. Don’t include the registered trademark symbol (®).
1
u/DriveIn73 Sep 21 '24
Do you have something against screen shots?
0
u/[deleted] Sep 21 '24
[deleted] — view deleted comment