You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+18-10
Original file line number
Diff line number
Diff line change
@@ -27,10 +27,10 @@ This list aims to assist by providing you with out-of-box templates and practica
27
27
-[General Tools](#general-tools)
28
28
-[Site Builder](#site-builder)
29
29
-[Wiki Builder](#wiki-builder)
30
-
-[Knowledge Base Builder](#knowledge-base-builder)
30
+
-[Knowledge Base](#knowledge-base)
31
31
-[Checker \& Formatter](#checker--formatter)
32
-
-[Diagramming Tool](#diagramming-tool)
33
-
-[Multimedia Tool](#multimedia-tool)
32
+
-[Diagramming](#diagramming)
33
+
-[Multimedia](#multimedia)
34
34
-[More Topics](#more-topics)
35
35
-[Comunities](#comunities)
36
36
-[Guidelines](#guidelines)
@@ -112,9 +112,8 @@ Answers frequently asked questions to quickly resolve common issues or clarify t
112
112
-[C4Sharp](https://github.com/8T4/c4sharp) - A .net library for building diagrams as code, based on C4 Model.
113
113
-[Goa Design - Model](https://github.com/goadesign/model) - Create your software architecture models and diagrams in Go. The Model DSL is implemented in Go and follows the C4 Model.
114
114
115
-
- Specification
116
-
117
-
- White Paper
115
+
-[Log4brains](https://github.com/thomvaill/log4brains) - Log Architecture Decision Records (ADR) right from your IDE and to publish them automatically as a static website.
116
+
-[Design Docs at Google](https://www.industrialempathy.com/posts/design-docs-at-google/) - Overview of how software design docs are used and written at Google.
118
117
119
118
### API Documentation
120
119
@@ -178,6 +177,7 @@ API is the univesal language of the software world, which needs to be documented
178
177
-[Best-README-Template](https://github.com/othneildrew/Best-README-Template) - An awesome README template to jumpstart your projects.
179
178
-[Awesome README](https://github.com/matiassingers/awesome-readme) - A curated list of awesome READMEs, including examples, articles and tools.
180
179
-[README template](https://gitlab.com/tgdp/templates/-/blob/main/readme/template-readme.md) - Open-source template provided by The Good Docs Project.
180
+
-[readme.so](https://github.com/octokatherine/readme.so) - An online drag-and-drop editor to easily build READMEs.
181
181
182
182
#### Comments
183
183
@@ -199,6 +199,7 @@ API is the univesal language of the software world, which needs to be documented
199
199
- JavaScript
200
200
-[JSDoc](https://github.com/jsdoc/jsdoc) - An API documentation generator for JavaScript.
201
201
-[documentation.js](https://github.com/documentationjs/documentation) - The documentation system for modern JavaScript.
202
+
-[Docz](https://github.com/doczjs/docz) - Write and publish beautiful interactive documentation for your code.
202
203
- TypeScript
203
204
-[TSDoc](https://github.com/microsoft/tsdoc) - A doc comment standard for TypeScript.
204
205
- Python
@@ -254,11 +255,14 @@ API is the univesal language of the software world, which needs to be documented
254
255
-[Docusaurus](https://github.com/facebook/docusaurus) - A project for building, deploying, and maintaining open source project websites easily.
255
256
-[Docsify](https://github.com/docsifyjs/docsify) - A magical documentation site generator.
256
257
-[MkDocs](https://github.com/mkdocs/mkdocs) - A fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
258
+
-[Material for MkDocs](https://github.com/squidfunk/mkdocs-material) - A powerful documentation framework on top of MkDocs.
259
+
-[mdBook](https://github.com/rust-lang/mdBook) - Create book from markdown files. Like Gitbook but implemented in Rust.
257
260
-[Sphinx](https://github.com/sphinx-doc/sphinx) - Make it easy to create intelligent and beautiful documentation.
258
261
-[Read the Docs](https://about.readthedocs.com/) - Hosts documentation for the open source community, which supports Sphinx docs written with reStructuredText.
-[Docco](https://github.com/jashkenas/docco) - A quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
261
264
-[bookdown](https://github.com/rstudio/bookdown) - Authoring Books and Technical Documents with R Markdown.
-[Doctave](https://github.com/Doctave/doctave) - A batteries-included developer documentation site generator.
263
267
264
268
### Wiki Builder
@@ -274,7 +278,7 @@ API is the univesal language of the software world, which needs to be documented
274
278
-[The Federated Wiki](https://www.writethedocs.org/videos/na/2015/keynote-the-federated-wiki-ward-cunningham/) - Use federation to ease sharing, by Ward Cunningham.
275
279
-[Node.js server version](https://github.com/fedwiki/wiki) - Federated Wiki node server as npm package.
276
280
277
-
### Knowledge Base Builder
281
+
### Knowledge Base
278
282
279
283
-[Documize](https://github.com/documize/community) - Modern Confluence alternative designed for internal & external docs.
280
284
-[Confluence in a Docker container](https://github.com/cptactionhank/docker-atlassian-confluence) - Atlassian Confluence wrapped in a Docker image.
@@ -296,13 +300,15 @@ API is the univesal language of the software world, which needs to be documented
296
300
-[Capitalize My Title](https://capitalizemytitle.com/) - An easy, smart title capitalization tool that uses title capitalization rules published by leading professional organizations to ensure your titles and headlines are capitalized correctly.
297
301
-[CasePolice](https://github.com/antfu/case-police) - Scan all your source files and fix the cases of known names.
298
302
299
-
### Diagramming Tool
303
+
### Diagramming
304
+
305
+
One diagram is usually worth more than a thousand words.
300
306
301
307
-[Excalidraw](https://github.com/excalidraw/excalidraw) - An open source virtual hand-drawn style whiteboard for sketching hand-drawn like diagrams.
302
308
-[draw.io](https://github.com/jgraph/drawio) (Open Source) - A JavaScript, client-side editor for general diagramming.
303
309
-[(Chinese) Architecture Diagramming: Tools and Methodologies](https://developer.aliyun.com/article/774446) - It discusses the benefits of using diagrams in architecture document, and highlights some standards and best practices.
304
310
305
-
### Multimedia Tool
311
+
### Multimedia
306
312
307
313
Documentation can be more than just plain texts and static pictures.
308
314
@@ -354,8 +360,10 @@ Documentation can be more than just plain texts and static pictures.
354
360
-[gd2md-html](https://github.com/evbacher/gd2md-html) - Convert a Google Doc to Markdown or HTML.
355
361
-[Markdown](https://www.wikiwand.com/en/Markdown) - A lightweight markup language for creating formatted text using a plain-text editor.
356
362
-[MarkText](https://github.com/marktext/marktext) - A simple and elegant markdown editor, available for Linux, macOS and Windows.
363
+
-[Glow](https://github.com/charmbracelet/glow) - A terminal based markdown reader, which can be used to read documentation directly on the command line.
357
364
-[AsciiDoc](https://asciidoc.org) - A plain text markup language for writing technical content.
358
-
-[Asciidoctor](https://github.com/asciidoctor/asciidoctor) - A fast, open source, Ruby-based text processor for parsing AsciiDoc® into a document model and converting it to output formats such as HTML 5, DocBook 5, manual pages, PDF, EPUB 3, and other formats.
365
+
-[Asciidoctor](https://github.com/asciidoctor/asciidoctor) - A fast, open source, Ruby-based text processor for parsing AsciiDoc and converting it to output formats such as HTML 5, DocBook 5, manual pages, PDF, EPUB 3, and other formats.
366
+
-[Antora](https://gitlab.com/antora/antora) - A modular documentation site generator that helps you organize and publish content written in AsciiDoc to the web.
359
367
-[reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) - The default plaintext markup language used by Sphinx.
360
368
-[DocBook](https://docbook.org/) - An XML schema for writing books and manuals about technical subjects.
361
369
-[LaTeX](https://www.latex-project.org/) - A document preparation system.
0 commit comments