-
Markmap vs Mermaid for Spec-Driven Development (SDD)
Markmap vs Mermaid for Spec-Driven Development You will consider sooner or later. When You have to go “full on AI” documentation stops being a nice-to-have and becomes a must be part of the product. We need to convey a lot of information, with hopefully as little text as possible so we can easily read it and digest the information. Two popular options for Markdown documentation features are Markmap and Mermaid. They solve different problems, and the best choice depends on whether you want fast idea mapping or more structured diagrams for flows. When to use Markmap Markmap turns Markdown headings and bullet points into an interactive mind map. Useful for…
-
Adr vs readme vs changelog
Adr, readme and changelog are the most valueable pieces of documentation that a project could? / should? maintain. They provide us with crucial, core informations we need to star and continue effective development. Let us look at them closely. Usually we can keep everything in plain text or better yet use a Markdown format. You can even try and use some linter, highlgihts for easier writing. ADR (Architectural Decision Record) ADR (Architectural Decision Record): Document that holds a single, significant architectural decision. Includes the context, options that were considered, chosen solution with consequences. Serves as a traceable rationale for future reference as well as new team members. Readme txt or…
-
What is an MCP (Model Context Protocol) data format ?
A regular MCP (Model Context Protocol) format follows JSON-RPC 2.0 encoded in UTF-8 standard. The format is design to easily integrate different tools used with AI and LLMS like Context7 ( used by visual code or intellij). Servers like Context7 are designed to integrate real-time, version-specific documentation and code examples directly into AI or coding assistant prompts to improve code accuracy and developer productivity. MCP naming conventions MCP naming conventions are usually : use lowercase letters, hyphens, or camelCase without spaces or special characters. Example filenames : The folder structure may organize docs by library by topic, component or any other phrase or category: MCP documentation file format MCP Context7…
-
Literate programming by Donald Knuth
Literate programming is a programming style introduced by Donald Knuth in 1984. The focus is on explaining the logic and reasoning behind a computer program (comments) to human readers, rather than just providing instructions for the computer ( plain source code ). The key ideas are: Definition Literate programming is a programming paradigm where a computer program is explained in natural language interspersed with snippets of macros and traditional source code. Purpose Used for reproducible research and open access in scientific computing and data science. Approach Literate programming by Donald Knuth Gives programmers templates to develop programs in the order demanded by the logic and flow of their thoughts. Moving…
