Rules for Writing Software Tutorials

This page summarizes the projects mentioned and recommended in the original post on news.ycombinator.com

CodeRabbit: AI Code Reviews for Developers
Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.
coderabbit.ai
featured
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com
featured
  1. ratatui-website

    Ratatui Documentation

    Make the tutorial text include the code verbatim from a working repo that passes CI. No pasting necessary. Sure you still have to verify that the tutorial text aligns with the code changes, but you don't have to do anything manual to update the code in the tutorial.

    As an actual example of this, here's a plugin for Remark that allows us to import specific functions from a rust source file. https://github.com/ratatui/ratatui-website/blob/main/src/plu... If the source code fails to compile, we get a CI error (in the rust checks). If the source code changes in a way where the import is no longer correct, we get a CI error (in the npm checks).

  2. CodeRabbit

    CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.

    CodeRabbit logo
  3. diataxis-documentation-framework

    A systematic approach to creating better documentation.

    For that topic some nice additional stuff: https://diataxis.fr/

  4. powerline-shell

    A beautiful and useful prompt for your shell

    I thought that using Makefile targets was the shortest friendliest to show what a project can do. Turns out make and Makefiles can be mysterious when they fail.

    Tutorials are "best-effort" and often don't dwell on the rabbit-holes they create when a poor soul runs astray of the sunny path.

    Example of a good tutorial:

    Python's powerline shell: https://github.com/b-ryan/powerline-shell

    The README is succinct. Well put together.

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

  • How to Create and Publish a Python Package on PyPI 🐍

    1 project | dev.to | 22 Jan 2025
  • Hacktoberfest 2024: Celebrating Open-Source and Community Collaboration! 🎉

    3 projects | dev.to | 26 Oct 2024
  • Hacktoberfest week 2

    3 projects | dev.to | 14 Oct 2024
  • The book documenting the curl project, the curl tool, libcurl and more

    1 project | news.ycombinator.com | 14 Sep 2024
  • Docusaurus – Build optimized websites quickly, focus on your content

    5 projects | news.ycombinator.com | 28 Aug 2024

Did you know that Python is
the 2nd most popular programming language
based on number of references?