Writing - Posts tagged technical-writing

50%

+0 −0

Q&A How do I write a report analyzing a system's weaknesses and how to address them?

2 answers · last activity about 1 month ago by Monica Cellio‭

Question business-writing technical-writing writing

71%

+3 −0

Q&A Does DRY (Don't Repeat Yourself) Apply to Documentation?

3 answers · last activity 2 months ago by Lundin‭

Question style technical-writing

66%

+2 −0

Q&A Linking documentation to Git commit comments

1 answer · last activity 3 months ago by Monica Cellio‭

Question tools technical-writing automation git source-control

71%

+3 −0

Q&A Good Examples of and Practices in Code Documentation

1 answer · last activity 3 months ago by Monica Cellio‭

Question technical-writing software-documentation examples api-documentation

75%

+4 −0

Q&A Technical Writer Skill Set

2 answers · last activity 3 months ago by Mark Baker‭

Question technical-writing

71%

+3 −0

Q&A Syntax summaries use brackets for optional elements; how do I represent literal brackets in a way readers will understand?

4 answers · last activity 4 months ago by Derek Elkins‭

Question style technical-writing

50%

+0 −0

Q&A Adding tags to documentation built in Flare?

0 answers · last activity 5 months ago by Monica Cellio‭

Question software tools software-documentation documentation

60%

+1 −0

Q&A For HTML documentation sets, are there meaningful guidelines for topic length?

2 answers · last activity 5 months ago by Monica Cellio‭

Question technical-writing software-documentation information-architecture

60%

+1 −0

Q&A How can we make images with (necessary) text more translatable mechanically?

1 answer · last activity 5 months ago by Monica Cellio‭

Question software tools translation technical-writing graphics

80%

+6 −0

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

4 answers · last activity 5 months ago by celtschk‭

Question terminology technical-writing user-guides writing

75%

+4 −0

Q&A Is there any benefit when writing out instructions to split it up into lots of little paragraphs, or is it better to leave it in one paragraph?

3 answers · last activity 7 months ago by Mark Baker‭

Question technical-writing

66%

+2 −0

Q&A How can we format code examples so that they work on a range of devices?

1 answer · last activity 9 months ago by manassehkatz‭

Question tools technical-writing formatting software-documentation examples

66%

+2 −0

Q&A How to structure a sentence containing long code examples?

4 answers · last activity 10 months ago by Monica Cellio‭

Question style technical-writing examples api-documentation

50%

+0 −0

Q&A Best practices for maintaining documented code examples?

4 answers · last activity 10 months ago by Monica Cellio‭

Question technical-writing software-documentation examples

60%

+1 −0

Q&A What are the benefits of including complete working code samples in documentation

4 answers · last activity 10 months ago by Monica Cellio‭

Question software-documentation examples api-documentation

84%

+9 −0

Q&A Is writing policy pages in a lighthearted manner harmful in any way?

2 answers · last activity 10 months ago by Mark Baker‭

Question technical-writing

75%

+4 −0

Q&A How do I approach rewriting an entire user guide in an agile environment?

2 answers · last activity 10 months ago by Secespitus‭

Question process technical-writing user-guides

66%

+2 −0

Q&A In end user documentation, should screenshots come before or after the text that references them?

2 answers · last activity 11 months ago by Monica Cellio‭

Question style technical-writing formatting graphics user-guides format

66%

+2 −0

Q&A Documenting framework features and descriptions

3 answers · last activity about 1 year ago by Monica Cellio‭

Question software technical-writing software-documentation documentation

71%

+3 −0

Q&A What is Documentation Design that I haven't already done?

1 answer · last activity about 1 year ago by Mark Baker‭

Question technical-writing

71%

+3 −0

Q&A Search page should link to advanced search options help page

0 answers · last activity about 1 year ago by Stevoisiak‭

Question feature-request user-guides user-interface search

71%

+3 −0

Q&A Computer science academic conference paper using "randvar" instead of "random variable"

1 answer · last activity about 1 year ago by Amadeus‭

Question technical-writing scientific-publishing

77%

+5 −0

Q&A The excessive use of 'and'

5 answers · last activity over 1 year ago by Mark Baker‭

Question style creative-writing technical-writing academic-writing

66%

+2 −0

Q&A How I should handle gender-neutral pronouns in technical writing?

3 answers · last activity over 1 year ago by Amadeus‭

Question language technical-writing gender

60%

+1 −0

Q&A How do you track dependencies for your co-authors?

4 answers · last activity over 1 year ago by Monica Cellio‭

Question collaboration tools process technical-writing

75%

+4 −0

Q&A How should I document a database schema?

3 answers · last activity over 1 year ago by ArtOfCode‭

Question software technical-writing software-documentation user-guides information-architecture documentation format

71%

+3 −0

Q&A What are the indentation rules for the paragraph introducing a bulleted list?

0 answers · last activity over 1 year ago by System‭

Question technical-writing formatting format

66%

+2 −0

Q&A Personal or impersonal in a technical resume

2 answers · last activity over 1 year ago by System‭

Question technical-writing resume

50%

+0 −0

Q&A What's the least distracting method to inform editors I'm a woman?

5 answers · last activity over 1 year ago by System‭

Question editing submitting-work technical-writing resume gender

66%

+2 −0

Q&A Acronyms in Technical Writing

4 answers · last activity over 1 year ago by System‭

Question style technical-writing acronyms

50%

+0 −0

Q&A How hard would it be to find writing jobs with an English degree?

1 answer · last activity over 1 year ago by System‭

Question degree career creative-writing technical-writing jobs

71%

+3 −0

Q&A How to move back to main section after finishing a sub-section

4 answers · last activity over 1 year ago by System‭

Question research technical-writing academic-writing outline

71%

+3 −0

Q&A Can basic grammar rules be skipped when writing text for machine safety labels?

9 answers · last activity over 1 year ago by System‭

Question technical-writing grammar

50%

+0 −0

Q&A High Tech Audience

2 answers · last activity over 1 year ago by System‭

Question audience technical-writing

50%

+0 −0

Q&A Should you emphasise text within quotation marks?

2 answers · last activity over 1 year ago by System‭

Question style punctuation technical-writing formatting format

60%

+1 −0

Q&A How to work on a new software feature that affects different topics

2 answers · last activity over 1 year ago by System‭

Question software technical-writing structure

60%

+1 −0

Q&A Wording of comparing X vs Y and X vs Z but not X vs Y vs Z

1 answer · last activity over 1 year ago by System‭

Question titles technical-writing academic-writing

50%

+0 −0

Q&A How to find the balance between research and the obvious

2 answers · last activity over 1 year ago by System‭

Question technique style technical-writing science narrative

60%

+1 −0

Q&A What's the common practice for warranty chapters in technical manuals?

2 answers · last activity over 1 year ago by System‭

Question technical-writing

60%

+1 −0

Q&A Ending a PhD thesis by saying "there is more to do"

4 answers · last activity over 1 year ago by System‭

Question ending technical-writing academic-writing

50%

+0 −0

Q&A Good tools for writing (game) manuals and sourcebooks

1 answer · last activity over 1 year ago by System‭

Question tools technical-writing

50%

+0 −0

Q&A Should I have an introducing paragraph in every chapter of my description?

1 answer · last activity over 1 year ago by System‭

Question technical-writing

50%

+0 −0

Q&A How to write to accommodate subsequent automatic translation

1 answer · last activity over 1 year ago by System‭

Question translation technical-writing

50%

+0 −0

Q&A Demo data in screenshots! What are the best practice?

1 answer · last activity over 1 year ago by System‭

Question technical-writing examples user-guides

50%

+0 −0

Q&A singular or plural for index entries

1 answer · last activity over 1 year ago by System‭

Question style technical-writing indexing

50%

+0 −0

Q&A What is the correct word/term that needs to be before the names of the maker of the project?

1 answer · last activity over 1 year ago by System‭

Question technical-writing academic-writing

50%

+0 −0

Q&A How to write time duration correctly

2 answers · last activity over 1 year ago by System‭

Question resources style time-depiction punctuation technical-writing

50%

+0 −0

Q&A Is it okay to call the reader's target audience stupid?

7 answers · last activity over 1 year ago by System‭

Question terminology technical-writing

50%

+0 −0

Q&A What is the word for the action of selecting an item by a mouse?

2 answers · last activity over 1 year ago by System‭

Question software technical-writing

60%

+1 −0

Q&A How to represent dependencies in outlines

2 answers · last activity over 1 year ago by System‭

Question technical-writing outline

Communities

Posts tagged technical-writing