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
+26-13
Original file line number
Diff line number
Diff line change
@@ -33,9 +33,10 @@ This list aims to assist by providing you with out-of-box templates and practica
33
33
-[Multimedia](#multimedia)
34
34
-[More Topics](#more-topics)
35
35
-[Comunities](#comunities)
36
-
-[Guidelines](#guidelines)
37
36
-[Examples](#examples)
38
37
-[Formats](#formats)
38
+
-[Guidelines](#guidelines)
39
+
-[Books](#books)
39
40
-[DocOps](#docops)
40
41
-[Localization](#localization)
41
42
-[Accessibility](#accessibility)
@@ -269,6 +270,7 @@ API is the univesal language of the software world, which needs to be documented
269
270
-[mdBook](https://github.com/rust-lang/mdBook) - Create book from markdown files. Like Gitbook but implemented in Rust.
270
271
-[Sphinx](https://github.com/sphinx-doc/sphinx) - Make it easy to create intelligent and beautiful documentation.
271
272
-[Read the Docs](https://about.readthedocs.com/) - Hosts documentation for the open source community, which supports Sphinx docs written with reStructuredText.
273
+
-[Markdoc](https://github.com/markdoc/markdoc) - A Markdown-based syntax and toolchain for creating custom documentation sites and experiences.
-[Docco](https://github.com/jashkenas/docco) - A quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
274
276
-[bookdown](https://github.com/rstudio/bookdown) - Authoring Books and Technical Documents with R Markdown.
@@ -348,17 +350,6 @@ Documentation can be more than just plain texts and static pictures.
348
350
-[Write the Docs](https://www.writethedocs.org/) - A global community of people who care about documentation.
349
351
-[The Good Docs Project](https://gitlab.com/tgdp) - Educates and empowers people to create high-quality documentation.
350
352
351
-
### Guidelines
352
-
353
-
-[Style Guides](https://www.writethedocs.org/guide/writing/style-guides/) - Collections of style guides from Write the Docs community.
354
-
-[Google developer documentation style guide](https://developers.google.com/style/highlights) - Provides editorial guidelines for writing clear and consistent Google-related developer documentation.
355
-
-[Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) - If you write about computer technology, this guide is for you.
356
-
-[Editorial guidelines for Apple](https://support.apple.com/guide/applestyleguide/welcome/web) - Provides guidelines to help maintain a consistent voice in Apple materials, including documentation.
357
-
-[GitHub Docs Style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide) - Make sure GitHub's documentation stays consistent and follows clear patterns that our readers can understand.
358
-
-[Red Hat Technical Writing Style Guide](https://stylepedia.net/style/) - Includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary.
359
-
-[Series: Writing Great Documentation](https://jacobian.org/series/great-documentation/) - A series of articles laying out the tools, tips, and techniques author learned over the years he've spent helping to write Django's docs.
360
-
-[Command Line Interface Guidelines](https://clig.dev/) - An open-source guide covering CLI help text and documentation.
361
-
362
353
### Examples
363
354
364
355
-[Beautiful Docs](https://github.com/matheusfelipeog/beautiful-docs.git) - Pointers to useful, well-written, and otherwise beautiful documentation.
@@ -368,7 +359,6 @@ Documentation can be more than just plain texts and static pictures.
368
359
369
360
- Converters
370
361
-[Pandoc](https://pandoc.org/) - A universal document converter, which can convert files from one markup format into another.
371
-
-[gd2md-html](https://github.com/evbacher/gd2md-html) - Convert a Google Doc to Markdown or HTML.
372
362
-[Markdown](https://www.wikiwand.com/en/Markdown) - A lightweight markup language for creating formatted text using a plain-text editor.
373
363
-[MarkText](https://github.com/marktext/marktext) - A simple and elegant markdown editor, available for Linux, macOS and Windows.
374
364
-[Glow](https://github.com/charmbracelet/glow) - A terminal based markdown reader, which can be used to read documentation directly on the command line.
@@ -379,6 +369,29 @@ Documentation can be more than just plain texts and static pictures.
379
369
-[DocBook](https://docbook.org/) - An XML schema for writing books and manuals about technical subjects.
380
370
-[LaTeX](https://www.latex-project.org/) - A document preparation system.
381
371
372
+
### Guidelines
373
+
374
+
-[Style Guides](https://www.writethedocs.org/guide/writing/style-guides/) - Collections of style guides from Write the Docs community.
375
+
-[Google developer documentation style guide](https://developers.google.com/style/highlights) - Provides editorial guidelines for writing clear and consistent Google-related developer documentation.
376
+
-[Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) - If you write about computer technology, this guide is for you.
377
+
-[Editorial guidelines for Apple](https://support.apple.com/guide/applestyleguide/welcome/web) - Provides guidelines to help maintain a consistent voice in Apple materials, including documentation.
378
+
-[GitHub Docs Style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide) - Make sure GitHub's documentation stays consistent and follows clear patterns that our readers can understand.
379
+
-[Red Hat Technical Writing Style Guide](https://stylepedia.net/style/) - Includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary.
380
+
-[Series: Writing Great Documentation](https://jacobian.org/series/great-documentation/) - A series of articles laying out the tools, tips, and techniques author learned over the years he've spent helping to write Django's docs.
381
+
-[Command Line Interface Guidelines](https://clig.dev/) - An open-source guide covering CLI help text and documentation.
382
+
383
+
### Books
384
+
385
+
-[Docs for Developers: An Engineer's Field Guide to Technical Writing](https://learning.oreilly.com/library/view/docs-for-developers/9781484272176/) - Teaches you the craft of documentation for each step in the software development lifecycle.
386
+
-[Technical Documentation and Process](https://learning.oreilly.com/library/view/technical-documentation-and/9781439861608/) - Provide the background and structure to help you document your projects more effectively.
387
+
-[Crafting Docs for Success : An End-to-End Approach to Developer Documentation](https://learning.oreilly.com/library/view/crafting-docs-for/9781484295946/) - Provide an easy to follow blueprint for building successful developer documentation by using the award winning platformOS developer portal as inspiration.
388
+
-[Docs-as-Ecosystem: The Community Approach to Engineering Documentation](https://learning.oreilly.com/library/view/docs-as-ecosystem-the-community/9781484293287/) - Teaches readers how mastering the docs-as-code ecosystem empowers communities to understand better their favorite products and Open-Source (OSS) technologies better.
389
+
-[Documenting Software Architectures: Views and Beyond, Second Edition](https://www.oreilly.com/library/view/documenting-software-architectures/9780132488617/) - Provides the most complete and current guidance, independent of language or notation, on how to capture an architecture in a commonly understandable form.
390
+
-[Communication Patterns](https://learning.oreilly.com/library/view/communication-patterns/9781098140533/) - Shows you how to create documentation and diagrams that actually get the message across to the different audiences you'll face.
391
+
-[Living Documentation: Continuous Knowledge Sharing by Design, First Edition](https://learning.oreilly.com/library/view/living-documentation-continuous/9780134689418/) - Use an Approach Inspired by Domain-Driven Design to Build Documentation That Evolves to Maximize Value Throughout Your Development Lifecycle.
392
+
-[Communicating Design: Developing Web Site Documentation for Design and Planning, Second Edition](https://learning.oreilly.com/library/view/communicating-design-developing/9780131385399/) - Shows you how to make the documentation you're required to provide into the most efficient communications tool possible.
393
+
-[Information Development: Managing Your Documentation Projects, Portfolio, and People](https://learning.oreilly.com/library/view/information-development-managing/9780471777113/) - A completely new look at best practices for all phases of the document development lifecycle.
394
+
382
395
### DocOps
383
396
384
397
-[DocOps Collection](https://doctoolhub.com/collection/docops/) - These articles offer an introduction to the concept of DocOps.
0 commit comments