The Documentation System

This page summarizes the projects mentioned and recommended in the original post on /r/programming

Our great sponsors
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • WorkOS - The modern identity platform for B2B SaaS
  • SaaSHub - Software Alternatives and Reviews
  • diataxis-documentation-framework

    A systematic approach to creating better documentation.

    Not mentioned in that site but the system is called diataxis. The linked page forks the code from the original place but edits out the original name? Fishy. credit where is due: here is the original

  • documentation-framework

    "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework

    It looks like the owner of the original repo has made changes in the new repo e.g. https://github.com/divio/diataxis-documentation-framework/commit/e0a5e428aab4c49a9be94685f8a5da1a1d213ba0.

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  • pgf

    A Portable Graphic Format for TeX

    The pgf/TikZ manual

  • fastapi

    FastAPI framework, high performance, easy to learn, fast to code, ready for production

    I don't even understand why these principle are so hard to get for some people. Take for example the FastAPI documentation: no reference at all, no explanation, and the tutorial flows into the how-to. If I want to know the details of a particular function I have to use the search bar to find all the pages it is mentioned on and try to puzzle out the complete function details from all the pieces.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts