惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

L
LINUX DO - 最新话题
cs.CV updates on arXiv.org
cs.CV updates on arXiv.org
PCI Perspectives
PCI Perspectives
cs.AI updates on arXiv.org
cs.AI updates on arXiv.org
K
KPMG report finds enterprise disconnect between AI and its ROI | CIO
H
Heimdal Security Blog
S
Security @ Cisco Blogs
N
News | PayPal Newsroom
J
Java Code Geeks
罗磊的独立博客
Security Archives - TechRepublic
Security Archives - TechRepublic
N
News and Events Feed by Topic
V
V2EX
WordPress大学
WordPress大学
Google Online Security Blog
Google Online Security Blog
N
News and Events Feed by Topic
www.infosecurity-magazine.com
www.infosecurity-magazine.com
月光博客
月光博客
AI
AI
小众软件
小众软件
The GitHub Blog
The GitHub Blog
MongoDB | Blog
MongoDB | Blog
A
Arctic Wolf
CTFtime.org: upcoming CTF events
CTFtime.org: upcoming CTF events
美团技术团队
Threat Intelligence Blog | Flashpoint
Threat Intelligence Blog | Flashpoint
Exploit-DB.com RSS Feed
Exploit-DB.com RSS Feed
Hacker News - Newest:
Hacker News - Newest: "LLM"
T
Tailwind CSS Blog
S
Schneier on Security
博客园 - 三生石上(FineUI控件)
F
Full Disclosure
B
Blog RSS Feed
Forbes - Security
Forbes - Security
S
SegmentFault 最新的问题
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知
人人都是产品经理
人人都是产品经理
云风的 BLOG
云风的 BLOG
Jina AI
Jina AI
Cisco Talos Blog
Cisco Talos Blog
U
Unit 42
Project Zero
Project Zero
H
Hacker News: Front Page
Y
Y Combinator Blog
Application and Cybersecurity Blog
Application and Cybersecurity Blog
The Cloudflare Blog
大猫的无限游戏
大猫的无限游戏
S
Secure Thoughts
The Hacker News
The Hacker News
Microsoft Azure Blog
Microsoft Azure Blog

Stonecharioteer on Tech

I Traced My Traffic Through a Home Tailscale Exit Node What Was I Reading Last? In Three Not-So-Easy Pieces Dogfooding Is Hard Code blocks in your books, finally GoForGo v0.9.0 Merrilin - We built an app to read books I use a Macbook now Data Structures & Algorithms - Preparing for Interviews Using a local DNS namespace for local service discovery Direction KOllector - Publishing KOReader Highlights gbt: branches touched in the last 24 hours A Soiree into Symbols in Ruby Some Smalltalk about Ruby Loops Ruby Blocks Returning from Ruby Blocks, Procs and Lambdas My Linux Laptop Finally Works: How Claude Helped Me Fix Years of Annoyances TIL: Watchexec - Modern File Watching for Development Workflows A Less Busy Mind GoForGo - Learn Go through live examples Migrating My Old Blog to Hugo with Claude The Qtile Window Manager: A Python-Powered Tiling Experience Read the RFCs that Built the Internet Py-x-Protobuf - Or How I Learned to Stop Worrying and Love Protocol Buffers Python Reverse a List New Beginnings Leaving ChainSafe Systems Screen Lock for Cinnamon Desktop using Zenity and Terminal Commands Crews Not Teams A System for Getting Better at LeetCode So Far So Rust Retrying HTTP Requests with Rust A Primer on Control Charts Learning Rust Explicit is Better than Implicit: Rust for Pythonistas Using Custom Delimiters in Jinja Templates TIL: Creating Fixed Length Iterables in Python Documentation Without Assumption Vagrant Python - A Reflection in 2022 Learning Golang No, A Virtual Machine Is Not Enough: Why Developers Need Native Linux Empathy in Tech For Those Who Came in Late A Weekend With PostgreSQL TIL: Gooey and Python Fire for Quick GUIs and CLIs TIL: 2ality - Dr. Axel Rauschmayer's JavaScript Blog TIL: MassDNS - High-Performance Bulk DNS Lookups TIL: Matomo Analytics, Google Tech Writing, Memory Programming, and NES TV Signals TIL: MontyDB - MongoDB Implemented in Python Returning to the Craft of Programming TIL: CPUFetch, OneFetch, and Learn CSS TIL: DNS Performance Testing and Pi-hole with Unbound TIL: Eli Bendersky's Blog, Awesome By Example, NoCoDB, and Martin Kleppmann TIL: CRDTs, Extreme HTTP Performance, and BYTEPATH Game TIL: AutoInvent, ASGI, Python Packaging, RAPIDS GPU Computing, and FlaskCon TIL: MangaDesk - Terminal Client for MangaDex TIL: McFly - Smart Shell History Search TIL: Siege Load Testing and Awesome FastAPI Resources TIL: Ventoy Bootable USB and Justniffer Network Analysis TIL: CLI Code Review, Git Split Diffs, and Internal Combustion Engine TIL: Benford's Law, Web Security Headers, Event Sourcing, and Mozilla Security Guidelines How to Write Documentation - The README.md File The Importance of Documentation TIL: NNgroup UX Research, SponsorBlock, and Labella Python Library TIL: The Little Book of Rust Macros and Rust Performance Book TIL: Git-Bug Distributed Issue Tracker and Omni Kubernetes Monitoring TIL: Zellij - Modern Terminal Multiplexer TIL: How Discord Handles 2.5 Million Concurrent Voice Users TIL: Volumio - The Audiophile Music Player TIL: Areopagitica - Milton's Defense of Free Speech TIL: Fast Node Manager, Zoxide Smart CD, Technical Writing, PyO3, and Qubes OS TIL: Slurm Workload Manager for HPC Clusters TIL: Data Visualization Guide and Oso Authorization Academy TIL: CORS Deep Dive, Piku Tiny PaaS, Rust Strings, and Deno Standard Library TIL: Raspberry Pi OS Development, Vim Beginner Guide, Password Management, and QueryBook TIL: uBlock Origin Performance Optimization on Firefox TIL: Breaking PostgreSQL at Scale and LeetCode Problem Patterns TIL: Awesome Tmux Resources for Terminal Multiplexing TIL: Grit - A Multitree-Based Personal Task Manager TIL: Lens 4.2 Kubernetes IDE, Shell Scripting Guide, and Dark HTTP Server Do The Job You Hate So You Won't Hate The Job You Love TIL: Innernet VPN Solution and NoteCalc Calculator App TIL: Argo CD for GitOps and Lens Kubernetes IDE TIL: Modern Rust CLI Tools - System Monitoring, HTTP Requests, and DNS TIL: tz - A Time Zone Helper Tool TIL: Distributed Systems Education, Fallacies, and Self-Hosted Internet Archiving TIL: Real-Time Voice Cloning Technology TIL: ChartMuseum for Helm, AMD's Corporate Journey, and Kubernetes Pod Scaling TIL: Docker and Kubernetes Tools - Whaler, Descheduler, and Dive TIL: Post-Mortem Collection, Terminal Plotting, and Technical Twitter TIL: Dark Mode Toggle Web Component by Google Chrome Labs TIL: Python eval(), exec(), and compile() Functions TIL: Camelot PDF Tables, PostgreSQL Row Level Security, Zerodha Varsity, and Write Yourself a Git TIL: fuser Command for Process and File Investigation TIL: i Hate Regex - The Ultimate Regex Cheat Sheet TIL: Dolt - Git for Data and Database Version Control TIL: x86 Assembly Programming and SafeEyes Break Reminder TIL: Comprehensive Distributed Systems Reading List TIL: Cosmopolitan C Library, Distributed Systems Book, High Performance Browser Networking, and Rust Roguelike Tutorial
TIL: Documentation Systems and Educational Resources
2020-07-17 · via Stonecharioteer on Tech

Today I explored my archive and discovered excellent resources on documentation systems, educational content, and structured learning approaches that every developer should know about.

The Four-Part Documentation System

Divio’s Documentation Framework

Divio’s Documentation System presents a revolutionary approach to organizing technical documentation into four distinct types:

The Four Types of Documentation

  1. Tutorials - Learning-oriented, hands-on lessons
  2. How-to Guides - Problem-oriented, step-by-step solutions
  3. Reference - Information-oriented, systematic descriptions
  4. Explanation - Understanding-oriented, theoretical knowledge

This framework was beautifully explained in the video What Nobody Tells You about Documentation - one of the greatest presentations on documentation structure I’ve encountered.

Why This Framework Works

Each documentation type serves a different user need:

                Learning        Working
    Study   |  Tutorials   |  How-to Guides  |
            |              |                 |
    Work    | Explanation  |   Reference     |

Tutorials guide newcomers through their first successful experience with your product. How-to guides solve specific real-world problems for experienced users. Reference materials provide systematic, complete information. Explanations clarify concepts and design decisions.

Documentation Type Examples

  • Tutorial: “Build your first Django app”
  • How-to: “How to deploy Django with Docker”
  • Reference: “Django settings configuration”
  • Explanation: “Why Django uses MVT architecture”

Google Season of Docs

Google Season of Docs is a program designed to improve open source documentation by connecting technical writers with open source communities. It’s similar to Google Summer of Code but focuses specifically on documentation projects.

Advanced Sphinx Documentation

Sphinx Tabs Extension

sphinx-tabs enables tabbed content in Sphinx documentation:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
.. tabs::

   .. tab:: Python

      .. code-block:: python

         def hello():
             print("Hello from Python!")

   .. tab:: JavaScript

      .. code-block:: javascript

         function hello() {
             console.log("Hello from JavaScript!");
         }

This creates clean, organized documentation where users can switch between different implementations or languages.

Modern Documentation Themes

MkDocs Material provides a beautiful Material Design theme for MkDocs documentation:

  • Responsive Design: Works perfectly on mobile and desktop
  • Search Integration: Fast client-side search
  • Dark Mode: Automatic theme switching
  • Navigation: Intuitive sidebar and navigation
  • Code Highlighting: Beautiful syntax highlighting

Computer Science Educational Resources

Comprehensive CS Curriculum

OSSU Computer Science Curriculum provides a complete Computer Science education using free online courses:

Self-Directed CS Education

The OSSU curriculum is equivalent to a complete CS degree, covering:

  • Programming fundamentals
  • Math for CS (calculus, statistics, discrete math)
  • Systems programming
  • Theory (algorithms, data structures)
  • Applications (databases, graphics, AI)
  • Unix, networking, and security

Specialized Learning Platforms

Missing Semester of Your CS Education - MIT course covering practical computing skills often overlooked in traditional CS programs:

  • Shell scripting and command-line tools
  • Version control with Git
  • Text editors (Vim)
  • Data wrangling
  • Virtual machines and containers
  • Security and cryptography

CS 61B Data Structures, Spring 2019 - Berkeley’s excellent data structures course with comprehensive materials and assignments.

Mathematics for Programming

Foundations of Applied Mathematics provides extensive Python and data science resources with mathematical foundations:

  • Linear Algebra: NumPy-based implementations
  • Optimization: Scipy optimization algorithms
  • Data Science: Statistics and machine learning
  • Numerical Methods: Computational mathematics

Programming Language Resources

Rust Learning Materials

Jon Gjengset’s YouTube Channel features intermediate Rust content:

  • Crust of Rust series
  • Live coding sessions
  • Advanced Rust concepts explanation
  • Real-world Rust applications

Jon Gjengset’s Blog includes excellent articles on distributed systems, including MIT 6.824 and RAFT consensus algorithm analysis.

Little Book of Rust Macros - Comprehensive guide to Rust’s macro system:

1
2
3
4
5
6
7
8
// Declarative macros
macro_rules! say_hello {
    () => {
        println!("Hello!");
    };
}

// Procedural macros for more complex transformations

Ruby Object-Oriented Design

Practical Object Oriented Design in Ruby - Sandi Metz is considered the definitive guide to OOP principles in Ruby. Metz explains complex concepts like:

  • Single Responsibility Principle
  • Dependency injection
  • Interface design
  • Testing strategies

POODR Philosophy

The purpose of design is to allow you to design later, and its primary goal is to reduce the cost of change.

Functional Programming

Common Lisp: A Gentle Introduction by David S. Touretzky provides an excellent introduction to functional programming concepts:

1
2
3
4
5
;; Recursive function definition
(defun factorial (n)
  (if (<= n 1)
      1
      (* n (factorial (- n 1)))))

Cryptography and Security

Learning Cryptography

Real World Cryptography - Modern approach to understanding cryptographic principles and implementations.

Understanding SHA Algorithms provides deep technical insight into SHA hash functions.

Cryptographic Demonstrations

SHA256 Animation - Visual representation of how SHA-256 hashing works, step by step.

Malicious SHA1 demonstrates practical collision attacks against SHA-1, showing why it’s no longer considered secure.

Project-Based Learning

Learning Through Building

Project-Based Learning Repository curates tutorials organized by programming language where you build real applications:

Project Categories

  • Web Development: Build a blog, e-commerce site, or social network
  • Game Development: Create games in various languages
  • Mobile Apps: iOS and Android development projects
  • Data Science: Analysis projects with real datasets
  • DevOps: Infrastructure and deployment projects

Learn AI from Scratch

Learn AI from Scratch takes a bottom-up approach to understanding artificial intelligence:

  1. Mathematical foundations
  2. Linear algebra and calculus
  3. Statistics and probability
  4. Machine learning algorithms
  5. Neural networks
  6. Deep learning

Specialized Technical Content

Advanced Screencast Resources

Semicolon&Sons Intermediate Screencasts provides high-quality technical screencasts covering advanced programming topics.

Data Structures Research

Succinct/Compact Data Structures for Python - implementations of space-efficient data structures:

1
2
3
4
5
6
7
# Succinct data structures use minimal space
# while maintaining fast query operations
from succinct import BitVector, RankSelect

# Compressed representation of binary data
bv = BitVector("1101001010")
rs = RankSelect(bv)

These structures are crucial for big data applications where memory efficiency is paramount.

Key Learning Insights

Documentation Best Practices

  1. Structure Matters: Use the four-type framework for comprehensive documentation
  2. User-Centric: Different users need different types of information
  3. Visual Enhancement: Tools like Sphinx tabs improve user experience
  4. Modern Themes: Good visual design increases documentation adoption

Educational Strategy

  1. Systematic Learning: Follow structured curricula like OSSU
  2. Practical Application: Project-based learning reinforces concepts
  3. Multiple Perspectives: Learn from various sources and authors
  4. Depth and Breadth: Balance specialized knowledge with general CS education

Technical Growth

  1. Fundamentals First: Strong mathematical and theoretical foundations
  2. Language Diversity: Exposure to different programming paradigms
  3. Security Awareness: Understanding cryptographic principles
  4. Modern Tools: Stay current with documentation and development tools

Continuous Learning Strategy

The best technical education combines structured learning (courses, books) with practical application (projects) and community engagement (open source, discussions). These resources provide multiple pathways to deep technical understanding.

This exploration reinforces that great technical education requires both systematic study and hands-on practice, supported by excellent documentation and learning resources.


These discoveries from my 2020 learning archive demonstrate the timeless value of well-structured educational content and documentation systems that serve learners at every level.