Search Results
| Search type | Search syntax |
|---|---|
| Tags | [tag] |
| Exact | "words here" |
| Author |
user:1234 user:me (yours) |
| Score |
score:3 (3+) score:0 (none) |
| Answers |
answers:3 (3+) answers:0 (none) isaccepted:yes hasaccepted:no inquestion:1234 |
| Views | views:250 |
| Code | code:"if (foo != bar)" |
| Sections |
title:apples body:"apples oranges" |
| URL | url:"*.example.com" |
| Saves | in:saves |
| Status |
closed:yes duplicate:no migrated:no wiki:no |
| Types |
is:question is:answer |
| Exclude |
-[tag] -apples |
| For more details on advanced search visit our help page | |
Results tagged with technical-writing
Search options not deleted
user 13337
Documentation, tutorials, training, user guides, installation guides, design documents, and all other types of technical documentation in any domain (not just software).
1
vote
I am writing a book on web design. What elements should I remove to avoid copyright issues?
If you want to feature a gallery of websites that you think represent good Web design, just ask the designers of those sites. Most will be happy to say yes. Doesn’t matter whether it is fair use or no …
- 1,368
2
votes
What is considered an acceptable length for a technical document?
I think the important metric is “is it usable?” I think it is really about the quality and organization of the table of contents and the index and the data. It doesn’t matter if it is 10,000 pages if …
- 1,368
3
votes
Order of names in title
If one of you is obviously senior to the other in some relevant way, then put that person’s name first. If you are both reasonably similar in standing, then put your names in alphabetical order.
- 1,368
0
votes
High Tech Audience
It is the same as any writing project: tell a story.
In technical writing, it is not only just as important to tell a story, it might be even more important than in other disciplines. The material ca …
- 1,368
5
votes
Can technical writing suck less
I think what you are missing is that all writing tells a story. Just because there is no love story or car chase, that does not mean your technical writing is not telling a story. You are just telling …
- 1,368
1
vote
Demo data in screenshots! What are the best practice?
You can use Sherlock Holmes, since he is a public domain fictional character and he has a famous fictional address. I think this adds a little fun but not so much that it is distracting, and it feels …
- 1,368
3
votes
Is there a standard for describing a form in a programming specification?
That table is not client-ready. I understand the technical terms like “dropdown” and “textarea” but those words should never be put in front of a client. Except for the rare exception who has some pro …
- 1,368
2
votes
Web-based WYSIWYG Markdown editor with commenting?
Ideally, the reviewers don’t get to do any editing, no matter what the workflow. Even if they just want to see a small change like uppercasing a word, it is better if they just put in a comment and yo …
- 1,368