19 repository-uri
Frameworks for maintaining technical documentation and specifications within version-controlled repositories.
Distinguishing note: Focuses on versioning documentation alongside code, distinct from general wiki or CMS tools.
Explore 19 awesome GitHub repositories matching software engineering & architecture · Documentation-as-Code Systems. Refine with filters or upvote what's useful.
This project is an automated technical writing tool that functions as a documentation-as-code framework. It parses source code and configuration files to generate structured instructional manuals and operational guides, ensuring that technical documentation remains synchronized with software updates through version control systems. The system utilizes large language model orchestration and static analysis to interpret codebase metadata and system definitions. By applying template-driven logic and context-aware prompt engineering, it transforms raw technical data into consistent, human-readabl
Maintains technical manuals within version control systems to ensure synchronization with software updates.
OpenSpec is a specification-driven development tool designed to maintain living documentation directly within a software repository. It functions as an automated documentation engine that tracks technical requirements alongside source code, ensuring that system specifications evolve in tandem with the implementation to prevent documentation drift. The framework distinguishes itself through differential change tracking, which compares current code states against stored specifications to identify deviations between intended requirements and actual implementation. By integrating specification st
Maintains system documentation as version-controlled files to ensure requirements evolve alongside the codebase.
Gitbook is a documentation-as-code platform designed for centralized technical knowledge management. It functions as a knowledge management system that synchronizes documentation files directly with version control repositories, allowing teams to maintain content alongside their source code. The platform distinguishes itself through an integrated artificial intelligence layer that provides context-aware search assistance and automated content suggestions. By utilizing block-based content modeling, it enables the construction of structured, modular documentation that can be compiled into stati
Provides a collaborative environment that synchronizes technical documentation with Git repositories.
This project is a comprehensive cybersecurity knowledge repository that provides a structured collection of technical documentation, training materials, and professional development roadmaps. It serves as a centralized resource for practitioners to navigate complex security disciplines, ranging from offensive and defensive fundamentals to specialized infrastructure and application security. The repository distinguishes itself through a modular resource framework that enables users to construct isolated cyber range environments for hands-on practice. It also features a specialized reference gu
Provides reproducible instructions for building isolated cyber ranges using version-controlled documentation.
This project provides a framework for capturing and managing architectural decision records within a version-controlled codebase. It functions as a documentation standard that enables engineering teams to record the context, rationale, and consequences of significant technical choices, ensuring that design history is preserved as a first-class artifact alongside the source code. The system distinguishes itself by integrating design documentation directly into the development lifecycle. By utilizing template-driven metadata, it enforces a consistent structure for all technical records, which f
Stores architectural records as versioned plain text files alongside the source code.
The ECMAScript specification is the formal standard defining the syntax, semantics, and execution model that all JavaScript implementations must follow. It establishes the official language rules through a combination of formal grammar and step-by-step algorithmic prose. The project manages the technical evolution of the language via a consensus-driven governance framework and a staged proposal pipeline. This process tracks features from initial design through expert reviewer sign-off and committee approval. A specification-as-code toolchain compiles these formal definitions and algorithmic d
Provides a toolchain that treats the formal specification as code, compiling it into a rendered technical document.
This project is a collection of programming language references and syntax cheat sheets designed for rapid developer onboarding. It serves as a library of code-based documentation that uses valid source code files to provide whirlwind tours of various language specifications. The project focuses on programming language learning by providing concise, commented code examples that explain core features and syntax in place. This approach enables developers to quickly grasp language-specific patterns, data types, and execution flow through a consistent reference format. The content covers a broad
Uses executable source code files as the primary vehicle for explaining language specifications and implementation.
This repository is a collection of solved algorithmic problems and data structure exercises designed for technical interview preparation. It serves as a polyglot reference implementation, providing a set of solved exercises based on a standard textbook to help candidates master the logic and complexity analysis required for coding tests. The project implements the same algorithmic logic across multiple programming languages to demonstrate platform-independent problem solving. This polyglot approach allows for the comparison of implementations across different tech stacks to highlight recurrin
Uses a documentation-as-code approach by storing logic explanations in version-controlled READMEs and comments.
This project is a structured catalog of server-side development questions and advanced Node.js concepts designed for senior-level interview preparation. It focuses on backend engineering topics including architecture, performance, and system design, while also covering Node.js internals, async patterns, and production debugging. The resource organizes interview topics into a navigable knowledge graph of interconnected concepts and subtopics, with explicit cross-references linking related ideas together. Content is presented through a question-driven learning path that guides the learner from
Explains each concept primarily through annotated code examples rather than prose.
Easy Rust is a beginner course and programming tutorial designed to teach the fundamentals of the Rust language. It provides instructional material and technical documentation tailored for those new to coding and non-native English speakers. The project uses simplified English to translate complex programming concepts into basic vocabulary. This approach bridges the gap between professional technical terminology and beginner-friendly language through concept-mapping and a modular, topic-based structure. The learning materials cover core programming fundamentals and systems programming basics
Illustrates abstract language rules and memory management using concrete, annotated code snippets.
This project is an AI software architecture library and reference framework for building applications powered by large language models. It provides a collection of reusable structural templates and modular code samples designed to organize complex artificial intelligence workflows. The framework emphasizes code-first documentation, using executable source code and verified reference implementations as the primary means of explaining feature implementation. It includes interactive prototyping playgrounds for testing prompts and configurations before they are integrated into a production codeba
Uses executable source code and verified implementations as the primary mechanism for feature documentation.
interpy-zh is the Chinese translation of the Intermediate Python book, an open-source educational resource that makes advanced Python concepts accessible to Mandarin-speaking readers. It serves as an intermediate-to-advanced Python tutorial, covering topics such as generators, decorators, and context managers for developers seeking deeper language mastery. The book is organized into sequential chapters that build from basic to advanced Python concepts, with each topic grouped into self-contained modules for focused study. It teaches primarily through runnable code snippets with inline annotat
Teaches concepts primarily through runnable code snippets with inline annotations and expected outputs.
Ultimate Python is a code-first educational resource for mastering the Python programming language. It organizes learning into self-contained, runnable modules that progress from fundamental syntax through advanced features, all without any external dependencies or build tools. The project is structured as a flat file hierarchy where each module is named by topic and can be executed independently. This design enables self-paced, hands-on practice with core Python concepts including built-in data structures, object-oriented programming, and advanced topics such as decorators, threading, and as
Teaches Python concepts through annotated, executable code examples as the primary explanation medium.
TypeSpec is a language for defining cloud API shapes and generating OpenAPI, JSON Schema, and client/server code from a single source of truth. It functions as a protocol-agnostic API designer that models REST, gRPC, and other API protocols using a unified, extensible syntax, with a decorator-based metadata system for attaching metadata, validation rules, and lifecycle visibility to API models and operations. The compiler produces OpenAPI 3.0 specifications and other artifacts, and the tool supports declaring API versions and tracking changes to models, properties, and operations across releas
Attaches sample parameter and return values to operations so tools generate realistic test data.
Acest proiect este o foaie de parcurs structurată pentru învățarea dezvoltării jocurilor și un curriculum de competențe tehnice. Oferă o reprezentare vizuală a conceptelor de bază, limbajelor de programare, motoarelor și instrumentelor necesare pentru a deveni un dezvoltator de jocuri profesionist. Foaia de parcurs mapează căile educaționale pentru educația în software-ul de jocuri și planificarea carierei. Include îndrumări specifice privind stăpânirea motoarelor de joc și vizualizarea relației dintre abilitățile de frontend, backend și devops necesare pentru a construi proiecte de jocuri complete. Curriculum-ul este organizat în căi de învățare structurate arborescent și livrat prin conținut bazat pe markdown. Proiectul folosește un flux de lucru de tip „documentație-ca-cod”, utilizând controlul versiunilor pentru a gestiona actualizările materialelor educaționale.
Employs a version-controlled workflow to manage educational content as source code via pull requests and peer reviews.
Cucumber-js este un instrument de dezvoltare bazată pe comportament (BDD) și un framework de automatizare a testelor de acceptare pentru JavaScript. Servește drept motor de automatizare a testelor care permite utilizatorilor să definească comportamentul sistemului folosind scenarii lizibile pentru oameni, mapând pașii în text simplu către cod executabil pentru a verifica dacă software-ul respectă regulile de business și criteriile de acceptare. Proiectul utilizează un framework bazat pe Gherkin pentru a crea documentație executabilă a sistemului în limbaj natural. Suportă localizarea multi-limbaj pentru scrierea scenariilor în diverse limbi vorbite și oferă instrumente pentru parametrizarea scenariilor și gruparea regulilor de business pentru a organiza criteriile de acceptare. Motorul acoperă o gamă largă de capabilități de testare, inclusiv automatizarea browserului end-to-end și automatizarea testelor API pentru verificarea endpoint-urilor serviciilor web. Gestionează execuția testelor prin procesare paralelă, mocking-ul dependențelor de infrastructură și injecția de dependențe pentru partajarea stării, pentru a menține continuitatea datelor între pași. Integrarea este suportată pentru pipeline-urile de livrare continuă (CI/CD), permițând executarea suitelor de teste automatizate prin servere de build pentru a verifica modificările de cod înainte de deployment.
Implements a documentation-as-code system where natural language specifications serve as executable tests.
Go42 este un ghid cuprinzător de programare și o referință pentru limbajul Go. Acesta servește drept studiu al specificațiilor oficiale ale limbajului și o colecție de design patterns derivate din logica internă și codul sursă al bibliotecii standard Go. Proiectul se concentrează pe analizarea implementărilor bibliotecii oficiale pentru a demonstra design patterns idiomatice și gândirea arhitecturală de bază. Acesta mapează tipare arhitecturale de nivel înalt pe funcționalități specifice ale limbajului pentru a susține dezvoltarea de software scalabil și ușor de întreținut. Materialul educațional este organizat prin studii de caz și analize tehnice ale erorilor comune de dezvoltare. Utilizează instrucțiuni bazate pe exemple pentru a explica regulile și sintaxa limbajului, trecând de la utilizarea de bază către competențe avansate de inginerie software.
Explains complex language rules and syntax using annotated code examples as the primary explanation medium.
TSDoc este un standard de documentație și o specificație pentru scrierea comentariilor structurate în codul TypeScript. Oferă un sistem portabil pentru definirea metadatelor, etichetelor și referințelor încrucișate în interiorul codului sursă pentru a asigura parsarea și randarea consistentă în diferite instrumente. Proiectul include un parser de comentarii doc care convertește comentariile într-un arbore de sintaxă structurat și un validator care impune consistența sintaxei. Permite definirea de etichete de documentație personalizate prin fișiere de configurare externe și suportă moduri multiple de validare a sintaxei pentru a asista la conformitatea cu specificațiile. Specificația acoperă o gamă largă de nevoi de documentare API, inclusiv marcarea etapelor de lansare, stabilitatea și deprecierea. Suportă detalierea parametrilor funcțiilor, valorilor returnate și tipurilor de excepții, precum și gestionarea vizibilității interne, moștenirii și referințelor încrucișate între declarații.
Designates code elements as unsuitable for third-party use to exclude them from public documentation.
likec4 is an architecture-as-code framework that transforms text-based architecture definitions into interactive diagrams, static websites, and image files. It serves as a system architecture visualizer and C4 model diagram generator, allowing users to define software components, boundaries, and deployment infrastructure using a domain-specific language. The tool distinguishes itself by providing a modeling environment with Language Server Protocol integration for real-time validation and autocomplete. It enables interactive architecture documentation where users can navigate through hierarch
Provides a framework for defining system architecture as code within version-controlled repositories.