📢 Various README templates & tips on writing high-quality documentation that people want to read.

💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)

📖 Highly customizable Project Docs / Wiki / Knowledge Base / Notes template for Hugo Website Builder. 创建项目文档

A template README for projects

CodebaseMD: A VS Code extension that converts codebases into structured Markdown documentation, optimized for LLMs and agentic coding tools. Features include syntax highlighting, directory visualization, project statistics, and our unique Micro Export format that intelligently condenses code into semantic patterns. Ideal for AI-assisted coding.

管理项目迭代及项目文档。

This open-source npm package leverages AI to analyze your project structure and automatically generate a professional, detailed, and SEO-friendly README file. It simplifies documentation by creating sections for installation, usage, features, and more—all tailored to your project. Perfect for developers looking to enhance project visibility.

管理项目迭代及项目文档。

Intent-based MCP server for project documentation search. Maps natural language queries to the right sources automatically—no configuration needed. The standard for AI agent documentation search.

📋uPlan - AI-powered development planning automation tool that generates structured project documents and to-do lists. Streamlines your planning workflow with template-based questions, Supports multiple AI models and offers customizable templates for development planning.

This repository houses a comprehensive README template tailored for projects encompassing artificial intelligence, machine learning, and data science. The template offers guidelines, structure, and best practices for effectively documenting and presenting your projects in these domains.

here is a comprehensive list of Markdown syntax along with examples for use in your README.md file, including Mermaid diagrams and code blocks for various programming languages.

Template repository aiming creation of the runbooks combined with basic lightweight documentation portal based on mkdocs, plantuml diagrams, and set of selected plugins

A collection of best-practice documentation templates for software projects. Ready to use with NestJS, NodeJS, Java, and more.

AQI prediction using Machine Learning (Linear Regression, Random Forest, XGBoost) with XGBoost as the best model, featuring data preprocessing, training, evaluation, and tuning for accurate air pollution insights. 🚀

Showcasing my journey through the '100 Days of Making' class, focusing on design engineering with web development, Next.js/React components, and WebGL.

A PowerShell tool for Windows that recursively scans a directory, captures its structure, and concatenates file contents. Perfect for creating detailed context for Large Language Models (LLMs) from your codebase.

Find functions, trace logic, and instantly 𝐯𝐢𝐬𝐮𝐚𝐥𝐢𝐳𝐞 𝐆𝐢𝐭𝐇𝐮𝐛 𝐩𝐫𝐨𝐣𝐞𝐜𝐭𝐬. Surface tech debt, hidden risks, and poor coding practices before they become problems.

A example of project docs using docsify, and a tool to automate implementing project docs

This repository contain some papers on indoor navigation. We used these papers to built a small model of indoor navigation which is fast and efficient. Documentation and python code of the project is given in the form of word document.