📢 Various README templates & tips on writing high-quality documentation that people want to read.
-
Updated
Mar 24, 2024
📢 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
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.
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.
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.
Template repository aiming creation of the runbooks combined with basic lightweight documentation portal based on mkdocs, plantuml diagrams, and set of selected plugins
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.
📋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.
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.
A example of project docs using docsify, and a tool to automate implementing project docs
collection of catalog and open layer (eps file -use Adobe Illustrator) files useful to create project catalog.
Interactive documentation generator that creates comprehensive markdown docs with project trees, TOC, and code navigation.
Repository for storing practice results in the Learning Intermediate Android Application Development class on Dicoding
Project charter is a statement of the scope, objectives, and participants in a project.
A automated way to create project's document for Ineuron Portal Projects.
Add a description, image, and links to the project-documentation topic page so that developers can more easily learn about it.
To associate your repository with the project-documentation topic, visit your repo's landing page and select "manage topics."