this repo has no description
🎨
+78
-78
+14
-14
Documentation.md
+14
-14
Documentation.md
···
2
2
3
3
- If your product/tool/process documentation is not good enough, people will not use it.
4
4
- The documentation for a project should live in the same repository as the code itself.
5
-
- Update documentation in lockstep when updating the codebase.
6
-
- Documentation should be **versioned**.
7
-
- Documentation changes should be reviewed in the same way as your code.
5
+
- Update documentation in lockstep when updating the codebase.
6
+
- Documentation should be **versioned**.
7
+
- Documentation changes should be reviewed in the same way as your code.
8
8
- [Documentation](https://diataxis.fr/) needs to include and be structured around its four different functions: [tutorials, how-to guides, technical reference and explanation](https://documentation.divio.com/introduction/). Each of them requires a distinct mode of writing.
9
-
- A tutorial is learning-oriented, allows the newcomer to get started, similar to a lesson. E.g: teaching a small child how to cook.
10
-
- A how-to guide is goal-oriented, shows how to solve a specific problem with a series of steps. E.g: a recipe in a cookery book.
11
-
- An explanation is understanding-oriented, provides background and context. E.g: an article on culinary social history.
12
-
- A reference guide is information-oriented, describes the machinery and is accurate and complete. E.g: a reference encyclopedia article.
9
+
- A tutorial is learning-oriented, allows the newcomer to get started, similar to a lesson. E.g: teaching a small child how to cook.
10
+
- A how-to guide is goal-oriented, shows how to solve a specific problem with a series of steps. E.g: a recipe in a cookery book.
11
+
- An explanation is understanding-oriented, provides background and context. E.g: an article on culinary social history.
12
+
- A reference guide is information-oriented, describes the machinery and is accurate and complete. E.g: a reference encyclopedia article.
13
13
- [If someone’s having to read your docs, it’s not "simple"](https://justsimply.dev/). Remove filler words.
14
14
- [Principles to keep in mind when writing documentation](https://mkaz.blog/misc/notes-on-technical-writing/).
15
-
- The purpose of technical writing is to help users accomplish tasks as quickly and effectively as possible.
16
-
- People learn by doing, prefer to be shown and not told.
17
-
- Get users to their first success quickly.
18
-
- There is more than one type of documentation.
19
-
- [Use second person](https://developers.google.com/style/person): "you" rather than "we".
20
-
- Keep it simple, write in plain language.
21
-
- [Use active voice](https://developers.google.com/style/voice): make clear who's performing the action.
15
+
- The purpose of technical writing is to help users accomplish tasks as quickly and effectively as possible.
16
+
- People learn by doing, prefer to be shown and not told.
17
+
- Get users to their first success quickly.
18
+
- There is more than one type of documentation.
19
+
- [Use second person](https://developers.google.com/style/person): "you" rather than "we".
20
+
- Keep it simple, write in plain language.
21
+
- [Use active voice](https://developers.google.com/style/voice): make clear who's performing the action.
22
22
- [As you are working in a team, then you have to address the problem of shared understanding](https://surfingcomplexity.blog/2022/11/24/writing-docs-well-why-should-a-software-engineer-care/). This is where documentation come in.
23
23
24
24
## Resources
+1
-1
Engineering Process.md
+1
-1
Engineering Process.md
···
6
6
4. Submit the smallest item of work that makes sense. When creating an issue describe the smallest fix possible, put suggestions for enhancements in separate issues and link them.
7
7
5. Do not leave issues open for a long time, issues should be actionable and realistic. If an issue has been addressed or is not relevant anymore, close it. If someone disagrees, they can re-open it and explain what is still relevant.
8
8
6. If you complete part of an issue and need someone else to take the next step, re-assign the issue to that person.
9
-
7. When working on an issue, ask for [[Feedback]] from your peers. Try to get a [review](https://github.com/thoughtbot/guides/tree/master/code-review) of your work. Even a quick look could do it. If they suggest changes, you get the opportunity to improve. This promotes [[Git#How to make a good Pull Request |collaboration and advances everyone's]] skills.
9
+
7. When working on an issue, ask for [[Feedback]] from your peers. Try to get a [review](https://github.com/thoughtbot/guides/tree/master/code-review) of your work. Even a quick look could do it. If they suggest changes, you get the opportunity to improve. This promotes [[Git#How to Make a Good Pull Request|collaboration and advances everyone's]] skills.
+6
-6
Feedback Loops.md
+6
-6
Feedback Loops.md
···
2
2
3
3
- [Every action creates an equal and opposite reaction. **When reactions loop back to affect themselves, a feedback loop is created**.](https://fs.blog/2011/10/mental-model-feedback-loops/)
4
4
- There are two types of feedback loops: positive and negative.
5
-
- Positive feedback amplifies system output, resulting in growth or decline.
6
-
- Negative feedback dampers output, stabilizes the system around an equilibrium point.
5
+
- Positive feedback amplifies system output, resulting in growth or decline.
6
+
- Negative feedback dampers output, stabilizes the system around an equilibrium point.
7
7
- **[[Network Effects |Things are connected]]**. Changing one variable in a [[Systems |system]] will affect other variables in that system and other systems. This is important because it means that designers must not only consider particular elements of a design, but also their relation to the design as a whole and to the greater environment.
8
8
- All complex [[systems]] are subject to positive and negative feedback loops whereby A causes B, which in turn influences A (and C), and so on – with higher-order effects frequently resulting from continual movement of the loop.
9
9
- Feedback loops vary in their accuracy.
10
-
- Accurate feedback means that it **reliably** and **clearly** tells you when you do something right. If you get the quadratic formula wrong, you can check the right formula and know what was wrong.
11
-
- Inaccurate feedback loop means that the results of the evaluation phase are “**noisy**” and contain significant variance, so the next cycle will need to take that into account. E.g: playing bowls without a coach.
12
-
- Learning under conditions of noisy data starts with world construction. Imagine a possible future, and repeat this to generate hundreds of possible future worlds. The main skills and resources required are creativity, [[slack]], and [equanimity](https://en.wikipedia.org/wiki/Equanimity). Creativity leads to a higher rate of idea generation and [[slack]] gives us more time to generate ideas. Equanimity is important because it allows us to persevere in the absence of tangible feedback.
10
+
- Accurate feedback means that it **reliably** and **clearly** tells you when you do something right. If you get the quadratic formula wrong, you can check the right formula and know what was wrong.
11
+
- Inaccurate feedback loop means that the results of the evaluation phase are “**noisy**” and contain significant variance, so the next cycle will need to take that into account. E.g: playing bowls without a coach.
12
+
- Learning under conditions of noisy data starts with world construction. Imagine a possible future, and repeat this to generate hundreds of possible future worlds. The main skills and resources required are creativity, [[slack]], and [equanimity](https://en.wikipedia.org/wiki/Equanimity). Creativity leads to a higher rate of idea generation and [[slack]] gives us more time to generate ideas. Equanimity is important because it allows us to persevere in the absence of tangible feedback.
13
13
- [The shorter and more accurate the feedback loop, the easier it is to learn](https://brianlui.dog/2020/05/10/beware-of-tight-feedback-loops/). The **tighter** your feedback loop, the better your work.
14
-
- Fast and accurate loops might get you on a local maximum or might not work when the underlying system is noisy.
14
+
- Fast and accurate loops might get you on a local maximum or might not work when the underlying system is noisy.
15
15
16
16
## Examples
17
17
+5
-5
Git.md
+5
-5
Git.md
···
23
23
1. Include the purpose of the Pull Request.
24
24
2. Provide an overview of why the work is taking place. Give a good background on why the change is happening.
25
25
3. Be explicit about what feedback you want, if any: a quick pair of :eyes: on the code, discussion on the technical approach, critique on design, a review of copy.
26
-
- [Explicitly list how to perform validation](https://www.brautaset.org/posts/levelling-up-pull-requests.html).
26
+
- [Explicitly list how to perform validation](https://www.brautaset.org/posts/levelling-up-pull-requests.html).
27
27
4. [Offering feedback](https://mtlynch.io/human-code-reviews-1/)
28
-
1. Familiarize yourself with the context of the issue, and reasons why this Pull Request exists.
29
-
1. Ask, don't tell.
30
-
1. Explain your reasons why code should be changed.
31
-
1. Be aware of negative bias with online [[Communication]]. Can you use positive language as opposed to neutral?
28
+
5. Familiarize yourself with the context of the issue, and reasons why this Pull Request exists.
29
+
6. Ask, don't tell.
30
+
7. Explain your reasons why code should be changed.
31
+
8. Be aware of negative bias with online [[Communication]]. Can you use positive language as opposed to neutral?
32
32
33
33
## Resources
34
34
+4
-4
Goals.md
+4
-4
Goals.md
···
16
16
17
17
## Interesting Goals
18
18
19
-
- Experiment with something you want to improve (A/B tests).
20
-
- Reduce daily decisions.
21
-
- [[Journaling |Journal]].
22
-
- Delete one bad habit (e.g: no sugar).
19
+
- Experiment with something you want to improve (A/B tests).
20
+
- Reduce daily decisions.
21
+
- [[Journaling|Journal]].
22
+
- Delete one bad habit (e.g: no sugar).
+28
-28
Ideas.md
+28
-28
Ideas.md
···
2
2
3
3
A few personal random ideas. A multitude of bad ideas is necessary for one good idea!
4
4
5
-
### Key Properties of Ideas
5
+
## Key Properties of Ideas
6
6
7
7
- Timeless.
8
8
- No replication costs.
9
9
- Creates win-win situations.
10
10
- [[Network Effects]].
11
11
12
-
### Interesting Areas
12
+
## Interesting Areas
13
13
14
14
- [[Open Data]]
15
15
- [[Governance]]
···
18
18
- [[Learning]]
19
19
- Science (biology, astrophysics, neuro, ...)
20
20
21
-
## Awesome Game
21
+
### Awesome Game
22
22
23
23
- Modular Approach. The idea is to have a main character and multiple shards to play. Each shard could implement a different rule set or genre.
24
24
- [[Modularity]] could also be implemented in the graphic side. You can choose the graphics pack you like just like another cosmetic.
25
25
- Player Driven Economy. Everything is made by players and traded for real life currency. The developers only get a fee for each trade. This makes the game fully F2P but also supports the developers.
26
26
- Companion Apps. Some tasks like trading or [[Planning]] could be done from a mobile device.
27
27
- Systems (items, skills, monsters, ...) could be affected by evolutionary processes.
28
-
- Merging two skills could produce a new one (inheriting properties and perhaps with a small mutation)
29
-
- Monsters will develop resistance against what's killing them.
30
-
- Quests rewards will also change dynamically.
28
+
- Merging two skills could produce a new one (inheriting properties and perhaps with a small mutation)
29
+
- Monsters will develop resistance against what's killing them.
30
+
- Quests rewards will also change dynamically.
31
31
- Players can vote for the next patch changes with in game money. This way developers gets feedback on what's important.
32
32
- Could have a GPS RPG extension. Locations in the real world would be named similarly to the real place but with a twist given by a Neural Network.
33
33
- Factions can take control of a region and build new things there.
34
34
35
-
## Unconventional Changelogs
35
+
### Unconventional Changelogs
36
36
37
37
- What if each city or town had a changelog? What changed in the last _release_? Did it change a street direction or opened a new commerce?
38
38
- What if stores had a changelog? That'd mean price history for each product and also new products would be easier to find.
39
39
40
-
## Fake Currencies
40
+
### Fake Currencies
41
41
42
42
- A chores app where kids could earn a currency. This could be traded for rewards like going to the cinema or getting a new PC game.
43
43
44
-
## Open Knowledge
44
+
### Open Knowledge
45
45
46
46
- Research.
47
-
- Each publication is a repository, where people can contribute to make corrections.
47
+
- Each publication is a repository, where people can contribute to make corrections.
48
48
- Distillation. Deeply digesting ideas, and putting them together into a framework of thinking.
49
-
- Made by a small number of people with a strong vision and a deep investment in the article.
49
+
- Made by a small number of people with a strong vision and a deep investment in the article.
50
50
- Publication.
51
-
- Should have different resolutions. E.g: Blog post for the general public, article for the scientific community, paper for the raw idea.
51
+
- Should have different resolutions. E.g: Blog post for the general public, article for the scientific community, paper for the raw idea.
52
52
53
-
## Personal Knowledge Base
53
+
### Personal Knowledge Base
54
54
55
55
A tool and framework to manage knowledge. This will allow compound learning and make it easier to discover new abstractions or connections between concepts. These are the key properties of my ideal PKB (could replace this handbook):
56
56
57
57
- Simple, Open Source and multi-platform. Works offline and has a backup mechanism similar to [[Git]].
58
58
- Focus on capturing ideas and content as fast as possible.
59
59
- Should be managed as a graph:
60
-
- Nodes are notes or smaller graphs. [Notes should be atomic, concept-oriented and densely linked](https://notes.andymatuschak.org/z4SDCZQeRo4xFEQ8H4qrSqd68ucpgE6LU155C).
61
-
- Bidirectional links connecting nodes.
62
-
- Nodes could have several parents (concepts).
63
-
- Users can remix and connect ideas in multiple overlapping hierarchies.
60
+
- Nodes are notes or smaller graphs. [Notes should be atomic, concept-oriented and densely linked](https://notes.andymatuschak.org/z4SDCZQeRo4xFEQ8H4qrSqd68ucpgE6LU155C).
61
+
- Bidirectional links connecting nodes.
62
+
- Nodes could have several parents (concepts).
63
+
- Users can remix and connect ideas in multiple overlapping hierarchies.
64
64
- [Each concept could be linked to external content (video, book, audio)](https://www.notion.so/Models-bb0f4bfd3cd140b3a00cd955e61003f9).
65
-
- Content should have tags (related concepts)
65
+
- Content should have tags (related concepts)
66
66
- Can be made public.
67
67
- Personal Knowledge bases can be personal [ontologies with similar core components (individuals, classes, attributes, relations, ...)](https://en.wikipedia.org/wiki/Ontology_components).
68
68
69
69
Instead of building the tool, we can start with a standard protocol and let other tools (Roam, Notion, Obsidian) use that.
70
70
71
-
### Open Source Projects
71
+
#### Open Source Projects
72
72
73
73
- [Logseq](https://logseq.com/).
74
74
- [Dendron](https://www.dendron.so/).
75
75
- [Foam](https://foambubble.github.io/).
76
76
- [Noosphere](https://github.com/subconsciousnetwork/noosphere)
77
77
78
-
## City Discovery
78
+
### City Discovery
79
79
80
80
- Create an activity similar to a gymkhana mixed with escape room. Players have to solve riddles and puzzles while learning about the city and its history.
81
81
- There might be digital and real life puzzles.
82
82
- Clues might be scattered across many checkpoints with actors as "NPC"s to guide the players.
83
83
- For big and closed areas, set up a Photo Battle Royale. You're out in a park. Make a group chat and eliminate people by making photos of them. The goal is to collect trophies without being eliminated.
84
84
85
-
## Social Network Improvements
85
+
### Social Network Improvements
86
86
87
87
- [[Federated Networks |Federate and open source current networks]] to improve communities.
88
-
- [The protocol should evolve differently for each community](https://youtu.be/P-2P3MSZrBM?t=5953). Communities will mix and match protocols (rules, monetization, rewarding, actions, [[governance]], ...) to make the protocol fit their network.
88
+
- [The protocol should evolve differently for each community](https://youtu.be/P-2P3MSZrBM?t=5953). Communities will mix and match protocols (rules, monetization, rewarding, actions, [[governance]], ...) to make the protocol fit their network.
89
89
- We need a social network that does not cause divisiveness and negativity that is currently the natural by-product of optimizing for greater engagement.
90
90
- How can the network [[Incentives |incentivize]] healthy conversations and encourage nuanced [[Resolving Disagreement |discussions]]?
91
91
92
-
## Web3 Recommendation Engine
92
+
### Web3 Recommendation Engine
93
93
94
94
- Since Ethereum wallets are public, you can get good data on which tokens people similar to you are holding.
95
95
- This might be useful to discover new assets.
96
96
97
-
## Web3 Data Pipelines
97
+
### Web3 Data Pipelines
98
98
99
99
- There is no Airbyte for blockchains.
100
100
- Everyone is reinventing the wheel, e.g: Dune does ETL, Flipside does it too, ...
101
101
102
-
## Structured Company Changelog
102
+
### Structured Company Changelog
103
103
104
-
- Create and maintain a *Company Changelog* in a table (structured and parse-able format) so it can be fed to something like Mixpanel or joined to other datasets to do analysis.
104
+
- Create and maintain a _Company Changelog_ in a table (structured and parse-able format) so it can be fed to something like Mixpanel or joined to other datasets to do analysis.
105
105
- Add data from other Sources:
106
-
- Github PRs
107
-
- OKRs
106
+
- Github PRs
107
+
- OKRs
108
108
- Use something like GitHub Releases to publish the changes and artifacts.
+3
-3
Identity.md
+3
-3
Identity.md
···
1
1
# Identity
2
2
3
3
- [Maintain a very small identity](http://www.paulgraham.com/identity.html). The act of labeling yourself is the act of restricting yourself to what you think fits that label. Don't have opinions on everything. Avoid forming an opinion at all about things that are not evident. Do not affiliate your identity with anything extrinsic - such as a religion, political party, country, company, profession, [[Programming]] language, social class, etc.
4
-
- Identity can be helpful in some cases. When we identity as something aligned with our [[Values]] and that can self correct (e.g: rationalism), it encourages you to behave better!
5
-
- [Try to affiliate more strongly with the communities whose core beliefs would be less dangerous if they turned out to be wrong](https://economicsdetective.com/2016/10/identity-mind-killer/).
6
-
- Identity labels are a way of [[Conceptual Compression]]. They help you infer some things about people that identify as something.
4
+
- Identity can be helpful in some cases. When we identity as something aligned with our [[Values]] and that can self correct (e.g: rationalism), it encourages you to behave better!
5
+
- [Try to affiliate more strongly with the communities whose core beliefs would be less dangerous if they turned out to be wrong](https://economicsdetective.com/2016/10/identity-mind-killer/).
6
+
- Identity labels are a way of [[Conceptual Compression]]. They help you infer some things about people that identify as something.
7
7
- You're not your opinions. Don't define yourself by what you work on or what you hate. Once a belief becomes part of your identity, any evidence that threatens the belief is a personal attack.
8
8
- The only constant in the world is that it changes. Identify as someone that changes their mind when the data changes!
+3
-3
Incentives.md
+3
-3
Incentives.md
···
6
6
7
7
> _"Simple, clear purpose and principles give rise to complex and intelligent behavior. Complex rules and regulations give rise to simple and stupid behavior"._ Dee Hock.
8
8
9
-
- To reach a [[Goals |goal]], reduce friction or increase incentives/rewards.
9
+
- To reach a [[Goals|goal]], reduce friction or increase incentives/rewards.
10
10
- To build better institutions, alter the incentive landscape. Great incentives create great outcomes.
11
11
- Humans are astonishingly bad at establishing incentives—we consistently invite manipulation and unintended consequences.
12
12
- You can’t force other people to change. You can, however, change just about everything else. And usually, that’s enough!
13
13
- Two types of incentives:
14
-
- Intrinsic incentives are internal—created by self-interest or desire.
15
-
- Extrinsic incentives are external—created by outside factors (reward, punishment).
14
+
- Intrinsic incentives are internal—created by self-interest or desire.
15
+
- Extrinsic incentives are external—created by outside factors (reward, punishment).
16
16
17
17
## Incentive Framework
18
18
+7
-7
Journaling.md
+7
-7
Journaling.md
···
10
10
- [Journaling is a tool you can use to better manage your mental health](https://nesslabs.com/dear-diary).
11
11
- There are many methods. Start with a simple one like "What worked, what didn't, what's next".
12
12
- Weekly Review:
13
-
- [Review what happened during the week](https://www.benkuhn.net/weekly/). How did the week go? Write down a list of topics to think about and take written notes on each topic as you think about them.
14
-
- Review a set of recurrent prompts. Tweak them over time. For example:
15
-
- Consistency at your core [[habits]] this week ([[Fitness]], [[Routine]], [[Productivity]], etc.). How can you tweak them to be more consistent or more useful?
16
-
- What did you do this week that was a mistake and how can I avoid repeating it?
17
-
- What would you like to accomplish next week?
18
-
- Do you need to clarify something?
19
-
- Which actions will you move closer to your [[goals]]?
13
+
- [Review what happened during the week](https://www.benkuhn.net/weekly/). How did the week go? Write down a list of topics to think about and take written notes on each topic as you think about them.
14
+
- Review a set of recurrent prompts. Tweak them over time. For example:
15
+
- Consistency at your core [[habits]] this week ([[Fitness]], [[Routine]], [[Productivity]], etc.). How can you tweak them to be more consistent or more useful?
16
+
- What did you do this week that was a mistake and how can I avoid repeating it?
17
+
- What would you like to accomplish next week?
18
+
- Do you need to clarify something?
19
+
- Which actions will you move closer to your [[goals]]?
+4
-4
Meetings.md
+4
-4
Meetings.md
···
8
8
- During the meeting, collect to-do’s, blockers/asks, and DRIs.
9
9
- You can add [[Feedback]] as an agenda item, and ask the participants to take a few minutes to jot down feedback for the next meeting.
10
10
- When asking for a meeting, send a message with:
11
-
1. **Purpose.** State reason for meeting. Include necessary information, links, context, ...
12
-
2. **Duration.** State restrictions (i.e. "at least 30 min", "at most 50min").
13
-
3. **Date.** State restrictions (i.e. "must happen before Aug 8.")
14
-
4. **Suggestions.** Pick three reasonable choices given restrictions and suggest them up front.
11
+
1. **Purpose.** State reason for meeting. Include necessary information, links, context, ...
12
+
2. **Duration.** State restrictions (i.e. "at least 30 min", "at most 50min").
13
+
3. **Date.** State restrictions (i.e. "must happen before Aug 8.")
14
+
4. **Suggestions.** Pick three reasonable choices given restrictions and suggest them up front.
15
15
16
16
## Update Meetings
17
17
+3
-3
Modularity.md
+3
-3
Modularity.md
···
2
2
3
3
Modularity is a property of [[Systems]]. It means:
4
4
5
-
- Loosely coupling. Breaking a chair shouldn't break the dinner!
6
-
- Multiple parts that play well together. This allows systems to develop [[Emergence]].
7
-
- Dividing a large systems into multiple smaller competing ones will make them evolve different rule-set and will allow you to pick the best one.
5
+
- Loosely coupling. Breaking a chair shouldn't break the dinner!
6
+
- Multiple parts that play well together. This allows systems to develop [[Emergence]].
7
+
- Dividing a large systems into multiple smaller competing ones will make them evolve different rule-set and will allow you to pick the best one.