This commit is contained in:
Correl Roush 2020-08-20 22:18:52 -04:00
parent 8506b25e98
commit a1bcba8c85
6 changed files with 43 additions and 18 deletions

View file

@ -18,11 +18,11 @@ Zettelkasten Method - LessWrong 2.0]], in which the author finds the linear
approach of filling a whole page restricting, and instead prefers taking many
/small/ notes and building connections.
[[file:20200716214603-taking_better_notes.org][Taking better notes]] builds a knowledgebase which, as it builds in content and in
trust, allows you to hold less in your head, freeing you up and improving focus.
While my [[file:20200717223216-work_log.org][Work log]] does a good job of archiving what I've been up to, the handful
of fuller, separate documents I occasionally write up tend to be more useful,
and certainly easier to find what I need in.
[[file:20200716214603-taking_better_notes.org][Taking better notes]] builds a knowledge-base which, as it builds in content and
in trust, allows you to hold less in your head, freeing you up and improving
focus. While my [[file:20200717223216-work_log.org][Work log]] does a good job of archiving what I've been up to, the
handful of fuller, separate documents I occasionally write up tend to be more
useful, and certainly easier to find what I need in.
* Chapter 2: Everything You Need To Do
#+begin_quote
@ -42,13 +42,22 @@ force it down your own throat.
Take fleeting notes and literature notes while reading through something, and
take some time (ideally, that same day while they're still fresh) to form them
into broader permanent notes based on your own thoughts, questions, and goals.
Write them out fully, as though explaining them to someone else, because these
notes will be what explains them to you again later on. Link them together in
broader topics that serve as an index to a variety of thoughts and ideas. These
notes can later be referenced when building up a full piece. In all likelyhood,
they won't be copied straight in, but instead built upon further.
[[file:20200820215905-write_in_full_sentences.org][Write them out fully]], as though [[file:20200820215950-write_conversationally.org][explaining them to someone else]], because these
notes will be what explains them to you again later on.
Link permanent notes together in broader topics that serve as an index to a
variety of thoughts and ideas. These notes can later be referenced when building
up a full piece. In all likelihood, they won't be copied straight in, but
instead built upon further.
Link notes together based not on a hierarchy of topics, but by /what will help
you to remember them later/. Doing so will keep your notes [[file:20200820220506-information_should_be_easy_to_find.org][easy to find]] when you
need them.
* Chapter 6: Simplicity Is Paramount
:PROPERTIES:
:ID: 3b99ba87-1f97-4bc3-9d6d-a7e0078b2c53
:END:
#+begin_quote
A typical mistake is made by many diligent students who are adhering to the
advice to keep a scientific journal. A friend of mine does not let any idea,
@ -79,13 +88,14 @@ value are generated from them.
Project notes exist for the specific purpose of supporting a particular effort,
and should be clearly delineated from the rest of the notes, while still being a
part of the overall collection. This is done to allow them to be discoverable
part of the overall collection. This is done to allow them to be [[file:20200820220506-information_should_be_easy_to_find.org][discoverable]]
while working on the project, but easily filtered when not, and to eventually be
archived off when the project is complete.
Permanent notes are the ones that remain valuable independent of any particular
project. It is these that you'll retain and revisit, and should be clearly
written with enough context to be understandable on their own.
written using organized, [[file:20200820215905-write_in_full_sentences.org][full sentences]] with enough context to be understandable
on their own.
Fleeting entries lack substance or context and clutter the collection.
Project-specific notes hold little relevance beyond the project itself, in

View file

@ -9,4 +9,4 @@ results and implications of that decision are.
* Resources
- [[https://adr.github.io/][ADR GitHub organization]]
- [[file:PhilippeKruchten1998.org][The decision view's role in software architecture practice]]
- [[file:PhilippeKruchten1998.org][The decision view's role in software architecture pracice]]

View file

@ -0,0 +1,6 @@
#+title: Write in full sentences
Use full sentences rather than only capturing fragments. This will be easier to
read in the future, and helps you to capture full thoughts in writing. While a
fragment may represent a nugget of information, the important context around it
may be lost.

View file

@ -0,0 +1,5 @@
#+title: Write conversationally
Write conversationally, explaining things throroughly for the reader. In all
likelihood, that reader will be you, and you'll appreciate not having to
struggle to remember long-forgotten details about the subject at hand.

View file

@ -0,0 +1,6 @@
#+title: Information should be easy to find
#+roam_alias: "Information should be discoverable"
Information captured in notes and documentation should be easy to find when you
need it. Related items should be organized and linked together such that it's
easy to follow a thought to the exact information you need.

View file

@ -28,11 +28,9 @@ decisions" in lightweight [[file:20200819222313-adrs.org][ADRs]] using a concise
ones. A particular decision may have positive, negative, and neutral
consequences, but all of them affect the team and project in the future.
The whole document should be one or two pages long. We will write each ADR as if
it is a conversation with a future developer. This requires good writing style,
with full sentences organized into paragraphs. Bullets are acceptable only for
The whole document should be one or two pages long. We will write each ADR [[file:20200820215950-write_conversationally.org][as if
it is a conversation]] with a future developer. This requires good writing style,
with [[file:20200820215905-write_in_full_sentences.org][full sentences]] organized into paragraphs. Bullets are acceptable only for
visual style, not as an excuse for writing sentence fragments. (Bullets kill
people, even PowerPoint bullets.)
#+end_quote
The suggested writing style is reminiscent of [[file:similarities_and_differences_between_evergreen_note_writing_and_zettelkasten.org][Evergreen note-writing]].