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-4
Original file line number
Diff line number
Diff line change
@@ -31,12 +31,14 @@ This list aims to assist by providing you with out-of-box templates and practica
31
31
-[Checker \& Formatter](#checker--formatter)
32
32
-[Diagramming](#diagramming)
33
33
-[Multimedia](#multimedia)
34
+
-[Commercial](#commercial)
34
35
-[More Topics](#more-topics)
35
36
-[Comunities](#comunities)
36
37
-[Examples](#examples)
37
38
-[Formats](#formats)
38
39
-[Guidelines](#guidelines)
39
40
-[Books](#books)
41
+
-[Courses](#courses)
40
42
-[DocOps](#docops)
41
43
-[Localization](#localization)
42
44
-[Accessibility](#accessibility)
@@ -83,7 +85,7 @@ Answers frequently asked questions to quickly resolve common issues or clarify t
83
85
84
86
-[The Facts About FAQs](https://www.writethedocs.org/videos/portland/2018/the-facts-about-faqs-ashleigh-rentz/) - Explore various questions we might frequently ask ourselves about FAQs.
85
87
86
-
#### In-app
88
+
#### In-app Documentation
87
89
88
90
Wizards, tooltips, onboarding, etc.
89
91
@@ -211,6 +213,7 @@ API is the univesal language of the software world, which needs to be documented
211
213
-[JSDoc](https://github.com/jsdoc/jsdoc) - An API documentation generator for JavaScript.
212
214
-[documentation.js](https://github.com/documentationjs/documentation) - The documentation system for modern JavaScript.
213
215
-[Docz](https://github.com/doczjs/docz) - Write and publish beautiful interactive documentation for your code.
216
+
-[Storybook](https://github.com/storybookjs/storybook) - A frontend workshop made for UI development, testing, and documentation.
214
217
- TypeScript
215
218
-[TSDoc](https://github.com/microsoft/tsdoc) - A doc comment standard for TypeScript.
216
219
- Python
@@ -242,15 +245,13 @@ API is the univesal language of the software world, which needs to be documented
242
245
- SQL
243
246
-[SchemaSpy](https://github.com/schemaspy/schemaspy) - Document your database simply and easily.
244
247
- CSS
245
-
-[Knyle Style Sheets](https://github.com/kneath/kss) - A methodology for documenting CSS and generating styleguides.
246
-
-[Hologram](https://github.com/trulia/hologram) - A Ruby gem that parses comments in your CSS and turns them into a beautiful styleguide.
247
248
248
249
### Test Documentation
249
250
250
251
- Test Plans
251
252
- Test Cases
252
253
- Test Report
253
-
-[Bug report template](https://gitlab.com/tgdp/templates/-/blob/main/bug-report/template-bug-report.md) - Open-source template provided by The Good Docs Project.
254
+
-[Bug report template](https://gitlab.com/tgdp/templates/-/blob/main/bug-report/template-bug-report.md) - Open-source template provided by The Good Docs Project.
254
255
- Coverage
255
256
- Performance
256
257
@@ -342,23 +343,32 @@ Documentation can be more than just plain texts and static pictures.
342
343
- Presentation Tools
343
344
-[Slidev](https://github.com/slidevjs/slidev) - Presentation slides for developers.
344
345
-[carbon](https://github.com/carbon-app/carbon) - Create and share beautiful images of your source code.
346
+
-[Code Hike](https://github.com/code-hike/codehike) - Helps you create a superior code reading experience, whether you are writing blog posts, documentation, tutorials, coding videos, or any type of technical content.
347
+
348
+
### Commercial
349
+
350
+
-[Writerside | JetBrains](https://www.jetbrains.com/writerside/) - The most powerful development environment – now adapted for writing documentation.
345
351
346
352
## More Topics
347
353
348
354
### Comunities
349
355
350
356
-[Write the Docs](https://www.writethedocs.org/) - A global community of people who care about documentation.
351
357
-[The Good Docs Project](https://gitlab.com/tgdp) - Educates and empowers people to create high-quality documentation.
358
+
-[Technical Writing | Reddit](https://www.reddit.com/r/technicalwriting/) - For people who take the unbelievably complicated things that scientists and engineers devise and make it understandable for non-technical people.
352
359
353
360
### Examples
354
361
355
362
-[Beautiful Docs](https://github.com/matheusfelipeog/beautiful-docs.git) - Pointers to useful, well-written, and otherwise beautiful documentation.
356
363
-[Awesome Open Source Documents](https://github.com/44bits/awesome-opensource-documents) - A curated list of awesome open source or open source licensed documents, guides, books.
364
+
-[Awesome Documentation | vipulgupta2048](https://github.com/vipulgupta2048/awesome-documentation) - A curated list of awesome real-life documentation examples.
365
+
-[9 Great API and Developer Documentation Examples](https://everydeveloper.com/developer-documentation-examples/) - Cover common areas of documentation, plus some areas you might not typically see called docs.
357
366
358
367
### Formats
359
368
360
369
- Converters
361
370
-[Pandoc](https://pandoc.org/) - A universal document converter, which can convert files from one markup format into another.
371
+
-[Mammoth](https://github.com/mwilliamson/mammoth.js) - Convert Word documents (.docx files) to HTML.
362
372
-[Markdown](https://www.wikiwand.com/en/Markdown) - A lightweight markup language for creating formatted text using a plain-text editor.
363
373
-[MarkText](https://github.com/marktext/marktext) - A simple and elegant markdown editor, available for Linux, macOS and Windows.
364
374
-[Glow](https://github.com/charmbracelet/glow) - A terminal based markdown reader, which can be used to read documentation directly on the command line.
@@ -392,6 +402,10 @@ Documentation can be more than just plain texts and static pictures.
392
402
-[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
403
-[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
404
405
+
### Courses
406
+
407
+
-[Technical Writing Courses for Engineers](https://developers.google.com/tech-writing) - This collection of courses and learning resources from Google aims to improve your technical documentation.
408
+
395
409
### DocOps
396
410
397
411
-[DocOps Collection](https://doctoolhub.com/collection/docops/) - These articles offer an introduction to the concept of DocOps.
0 commit comments