Repository navigation
project-documentation
- Website
- Wikipedia
📢 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.
📋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.
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.
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.
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.
Showcasing my journey through the '100 Days of Making' class, focusing on design engineering with web development, Next.js/React components, and WebGL.
Project charter is a statement of the scope, objectives, and participants in a project.
My personal GitHub Pages website (theme forked from Chirpy)
A automated way to create project's document for Ineuron Portal Projects.
The overall objective of this project is to provide a ready-to-use documentation model with English/French bilingual parameters and versioning parameters.