mirror of
https://github.com/foo-dogsquared/wiki.git
synced 2025-02-07 12:19:31 +00:00
Update the notes on classic prose
This commit is contained in:
parent
439764ce63
commit
71f59658bd
@ -1,6 +1,6 @@
|
|||||||
#+title: Create examples of ranking complexity when documenting your project serving as a quick glance
|
#+title: Create examples of ranking complexity when documenting your project serving as an abstract
|
||||||
#+date: "2021-02-28 14:52:58 +08:00"
|
#+date: "2021-02-28 14:52:58 +08:00"
|
||||||
#+date_modified: "2021-04-07 16:17:57 +08:00"
|
#+date_modified: "2021-04-22 14:57:12 +08:00"
|
||||||
#+language: en
|
#+language: en
|
||||||
|
|
||||||
|
|
||||||
@ -9,5 +9,5 @@ This gives a quick introduction to the tool as well as subtly giving hints about
|
|||||||
Examples include the manual pages from [[https://www.freebsd.org/][the FreeBSD project]] where each tool is given a dedicated section for example usage.
|
Examples include the manual pages from [[https://www.freebsd.org/][the FreeBSD project]] where each tool is given a dedicated section for example usage.
|
||||||
Another that stuck out to me is the README of [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][maim]], a screenshot capture tool, where one of the examples demonstrate that you can pipe binary output which leads to useful things such as [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][OCR selection]] or a colorpicker.
|
Another that stuck out to me is the README of [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][maim]], a screenshot capture tool, where one of the examples demonstrate that you can pipe binary output which leads to useful things such as [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][OCR selection]] or a colorpicker.
|
||||||
|
|
||||||
This is not only useful for software documentation, it is also useful for technical writings especially applied with [[file:2021-04-07-15-09-24.org][Classic prose]].
|
This is not only useful for software documentation, it is also useful for technical writings.
|
||||||
This makes it easier to skim (see [[file:2021-04-05-12-43-36.org][Speedreading is all about skimming well]]) and review it as a future reference (see [[file:2021-04-06-22-25-17.org][Learn more with referencing with a bit of remembering]]).
|
This makes it easier to skim (see [[file:2021-04-05-12-43-36.org][Speedreading is all about skimming well]]) and review it as a future reference (see [[file:2021-04-06-22-25-17.org][Learn more with referencing with a bit of remembering]]).
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
#+title: Classic prose
|
#+title: Classic prose
|
||||||
#+date: "2021-04-07 15:09:24 +08:00"
|
#+date: "2021-04-07 15:09:24 +08:00"
|
||||||
#+date_modified: "2021-04-07 16:33:04 +08:00"
|
#+date_modified: "2021-04-22 15:02:06 +08:00"
|
||||||
#+language: en
|
#+language: en
|
||||||
#+tags: writing
|
#+tags: writing
|
||||||
|
|
||||||
@ -19,14 +19,9 @@ For example, with the saying "The people of America are getting fatter.", we bot
|
|||||||
Just like in a casual conversation, the reader has a rough idea of what they're reading.
|
Just like in a casual conversation, the reader has a rough idea of what they're reading.
|
||||||
They are reading to see what the writer has to do something about the subject.
|
They are reading to see what the writer has to do something about the subject.
|
||||||
|
|
||||||
The guideline of keeping it as objective as possible makes
|
The guideline of keeping it as objective as possible also encourages being concise.
|
||||||
|
You can [[file:2021-02-28-14-52-58.org][Create examples of ranking complexity when documenting your project serving as a abstract]].
|
||||||
|
It is written on equal footing with the reader, after all.
|
||||||
|
Thus, any writing suited to impress is a pointless addition (and can rub the wrong way for the reader).
|
||||||
|
|
||||||
Consequently, this reduces the fluff that you often see in academic writings or legal documents such as:
|
Consequently, this [[file:2021-04-22-15-00-34.org][Reduce writing fluff]] that you often see in academic and legal writings.
|
||||||
|
|
||||||
- Apologizing (e.g., "...as the theory of multiverses is not yet proven as of the time of this writing, more research is required on how we define superheroes").
|
|
||||||
- Philosophical non-sequiturs (e.g., "In order to create a deviled egg, first we need to ask is cooking.").
|
|
||||||
- Hedging (e.g., probably, somewhat, all I know is, I'm not an expert but).
|
|
||||||
- Metaconcepts (e.g., perspective, approaches).
|
|
||||||
- Clichés (e.g., walk in a park, knock peoples' socks off).
|
|
||||||
- Thingification of verbs and adjectives (e.g., "make an appearance" instead of "appear", "bringing doom" instead of "destroy").
|
|
||||||
- Scare quotes (e.g., "so-called", "in-the-know").
|
|
||||||
|
18
2021-04-22-15-00-34.org
Normal file
18
2021-04-22-15-00-34.org
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
#+title: Reduce writing fluff
|
||||||
|
#+date: "2021-04-22 15:00:34 +08:00"
|
||||||
|
#+date_modified: "2021-04-22 15:08:51 +08:00"
|
||||||
|
#+language: en
|
||||||
|
|
||||||
|
|
||||||
|
The problem with a lot of writings is they can be filled with unnecessary things.
|
||||||
|
From research writings, blog posts, legal documents, and even your own notes.
|
||||||
|
The most important factor is to be readable and well-understood by an outsider or yourself after a set amount of time.
|
||||||
|
The following list is the things I need to keep in mind when writing.
|
||||||
|
|
||||||
|
- Apologizing (e.g., "...as the theory of multiverses is not yet proven as of the time of this writing, more research is required on how we define superheroes").
|
||||||
|
- Philosophical non-sequiturs (e.g., "In order to create a deviled egg, first we need to ask is cooking.").
|
||||||
|
- Hedging (e.g., probably, somewhat, all I know is, I'm not an expert but).
|
||||||
|
- Metaconcepts (e.g., perspective, approaches, identities, entities).
|
||||||
|
- Clichés (e.g., walk in a park, knock peoples' socks off).
|
||||||
|
- Thingification of verbs and adjectives (e.g., "make an appearance" instead of "appear", "bringing doom" instead of "destroy").
|
||||||
|
- Scare quotes (e.g., "so-called", "in-the-know").
|
Loading…
Reference in New Issue
Block a user