search

sanjar-notes / swe-tools

Software engineering culture and tools
0 stars 0 forks source link

React Navigation very good role model for documentation and notes #27

Open sanjarcode opened 7 months ago

sanjarcode commented 7 months ago

https://reactnavigation.org/

  1. Fundamentals - learn enough to not be blank (can code). List of imp jargon.
  2. Guides - focused info about library constructs. As well as common important patterns and scenarios. Talks and code examples.
  3. API reference - for fast code exploration, signature and structure lookup. Code, less talk. "Show me the code".
  4. Meta - pitch, anti-pitch, discussion
    • Libraries - sub libraries and tools. Optional

etc

sanjarcode commented 7 months ago

For personal notes, the fundamentals and guides sections are very relevant - one introduces primary constructs and gotchas, while the second is about deep dives and patterns we learn with experience.

Having vault bifurcated into two sections would solve the "too much detail when revising issue"