Skip to content

Commit

Permalink
post on writing resources
Browse files Browse the repository at this point in the history
  • Loading branch information
mloning committed Jan 12, 2025
1 parent a8dc890 commit 440fdce
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions content/posts/writing-well.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
---
title: "Writing well"
date: 2024-12-14T11:54:52+01:00
date: 2025-01-12T11:54:52+01:00
last_modified: .Lastmod
draft: true
draft: false
---

In my writing, I first try to be as concise as possible.
I try to keep sentences short and avoid all words that don't convey any meaning.
In a second iteration, I can then add words or combine sentences if the text feels too dry or lacks fluidity.
Here are some resources for writing well.

## Resources

Writing well
## General writing

- "Style: The Basics of Clarity and Grace" (3rd Edition) 3rd Edition, by Joseph M. Williams
- "The Chicago Manual of Style", 16th Edition Sixteenth Edition, by University of Chicago Press Staff
- https://matt.might.net/articles/shell-scripts-for-passive-voice-weasel-words-duplicates/
- Style: The Basics of Clarity and Grace (3rd Edition) 3rd Edition, by Joseph M. Williams
- The Chicago Manual of Style, 16th Edition Sixteenth Edition, by University of Chicago Press Staff

Writing technical docs
## Technical docs

- A Manual for Writers of Research Papers, Theses, and Dissertations, Seventh Edition: Chicago Style for Students and Researchers (Chicago Guides to Writing, Editing, and Publishing) 7th Edition, by Kate L. Turabian (Author), Wayne C. Booth Gregory G. Colomb Joseph M. Williams
- https://blog.pragmaticengineer.com/scaling-engineering-teams-via-writing-things-down-rfcs/
- https://www.industrialempathy.com/posts/design-docs-at-google/
- https://github.com/joelparkerhenderson/architecture-decision-record/
- https://surfingcomplexity.blog/2022/11/24/writing-docs-well-why-should-a-software-engineer-care/

Writing tutorials
## Tutorials

- https://refactoringenglish.com/chapters/rules-for-software-tutorials/

0 comments on commit 440fdce

Please sign in to comment.