Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read
Q&A

Posts tagged user-guides

Subtag of technical-writing

This tag doesn't have any usage information yet.

This tag doesn't have a detailed wiki yet.

75%
+4 −0
Q&A How should I document a database schema?

I am going to be writing some user-facing documentation for a database that visitors can query. That is, the people writing queries are not the ones who created the database; they can come in, look...

3 answers  ·  posted 8y ago by Monica Cellio‭  ·  edited 1y ago by Monica Cellio‭

81%
+7 −0
Q&A mice don't tap and tablet-users don't click: what word can I use for all audiences instead?

I am documenting features on a web site. The audience is end users, who could be anywhere from seasoned Internet veterans to relatively new people who came for my site's content but aren't general...

4 answers  ·  posted 2y ago by Monica Cellio‭  ·  edited 1y ago by Canina‭

75%
+4 −0
Q&A How do I approach rewriting an entire user guide in an agile environment?

I'm tasked with rewriting an entire user guide that hasn't been updated for years at a company and I am the only technical writer on the team. Only release notes were sent out all these years. The ...

2 answers  ·  posted 8y ago by john_doe‭  ·  last activity 2y ago by Secespitus‭

66%
+2 −0
Q&A In end user documentation, should screenshots come before or after the text that references them?

The end user documentation I'm writing makes use of screenshots (and partial screenshots) to show the user what I'm referring to in procedural instructions or conceptual explanations of the softwar...

2 answers  ·  posted 9y ago by Matthew Rodatus‭  ·  last activity 2y ago by Monica Cellio‭

71%
+3 −0
Q&A Search page should link to advanced search options help page

The question search page has a short description of advanced search options, but it doesn't tell users what search operators are available. It should include a link to the advanced search options ...

0 answers  ·  posted 3y ago by Stevoisiak‭  ·  edited 3y ago by Stevoisiak‭

50%
+0 −0
Q&A Demo data in screenshots! What are the best practice?

My question is related to best practices of making screenshots for end-user documentation. Particularly, is there universal information for filling in forms in the software and after that making sc...

1 answer  ·  posted 9y ago by Yuliya Drygybka‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A Format keyboard keys in documents

I'm writing a guide to give step-by-step instructions to complete some tasks on the computer. At some points, I need to indicate pressing keys on the keyboard; how may I format the letter/symbol to...

1 answer  ·  posted 7y ago by Oxwivi‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A Best Tool to Create User Guides

We are planning to create a user guide for internal use only. It's 150-page document in Word for a self-developed SW tool. The user guide will require constant update. No translation is needed. We ...

2 answers  ·  posted 8y ago by xifeng‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A Present tense in user manuals

I am writing a user manual for an IT system. And inside the user manual I have sentences such as: Users can delete Servers that do not have Customers assigned to them. Is the use of present...

1 answer  ·  posted 8y ago by John John‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A Preferred word for "preferred", "target", "chosen" in end user support documentation

I'm having trouble finding and sticking to one word to indicate whatever value the user intends to use with my instructions. For example: Select your preferred printer. I'm wondering what s...

2 answers  ·  posted 3y ago by Pierce Devol‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A Formatting of Text in Technical Writing (Procedure Writing)

In a procedure, when describing a UI component, we use the bold font to represent UI components. We also match the text with the letter case of the UI component. But do we need to match the font st...

2 answers  ·  posted 5y ago by Krishna Baboor‭  ·  last activity 3y ago by System‭

This community is part of the Codidact network. We have other communities too — take a look!

You can also join us in chat!

Want to advertise this community? Use our templates!

Like what we're doing? Support us! Donate