Skip to content

Commit 203a1f9

Browse files
committed
Add more resources
1 parent e4376b6 commit 203a1f9

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@ This list aims to assist by providing you with out-of-box templates and practica
3131
- [Checker \& Formatter](#checker--formatter)
3232
- [Diagramming](#diagramming)
3333
- [Multimedia](#multimedia)
34+
- [Commercial](#commercial)
3435
- [More Topics](#more-topics)
3536
- [Comunities](#comunities)
3637
- [Examples](#examples)
3738
- [Formats](#formats)
3839
- [Guidelines](#guidelines)
3940
- [Books](#books)
41+
- [Courses](#courses)
4042
- [DocOps](#docops)
4143
- [Localization](#localization)
4244
- [Accessibility](#accessibility)
@@ -83,7 +85,7 @@ Answers frequently asked questions to quickly resolve common issues or clarify t
8385

8486
- [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.
8587

86-
#### In-app
88+
#### In-app Documentation
8789

8890
Wizards, tooltips, onboarding, etc.
8991

@@ -211,6 +213,7 @@ API is the univesal language of the software world, which needs to be documented
211213
- [JSDoc](https://github.com/jsdoc/jsdoc) - An API documentation generator for JavaScript.
212214
- [documentation.js](https://github.com/documentationjs/documentation) - The documentation system for modern JavaScript.
213215
- [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.
214217
- TypeScript
215218
- [TSDoc](https://github.com/microsoft/tsdoc) - A doc comment standard for TypeScript.
216219
- Python
@@ -242,15 +245,13 @@ API is the univesal language of the software world, which needs to be documented
242245
- SQL
243246
- [SchemaSpy](https://github.com/schemaspy/schemaspy) - Document your database simply and easily.
244247
- CSS
245-
- [Knyle Style Sheets](https://github.com/kneath/kss) ![GitHub Repo stars](https://img.shields.io/github/stars/kneath/kss) - A methodology for documenting CSS and generating styleguides.
246-
- [Hologram](https://github.com/trulia/hologram) ![GitHub Repo stars](https://img.shields.io/github/stars/trulia/hologram) - A Ruby gem that parses comments in your CSS and turns them into a beautiful styleguide.
247248

248249
### Test Documentation
249250

250251
- Test Plans
251252
- Test Cases
252253
- 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.
254255
- Coverage
255256
- Performance
256257

@@ -342,23 +343,32 @@ Documentation can be more than just plain texts and static pictures.
342343
- Presentation Tools
343344
- [Slidev](https://github.com/slidevjs/slidev) - Presentation slides for developers.
344345
- [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.
345351

346352
## More Topics
347353

348354
### Comunities
349355

350356
- [Write the Docs](https://www.writethedocs.org/) - A global community of people who care about documentation.
351357
- [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.
352359

353360
### Examples
354361

355362
- [Beautiful Docs](https://github.com/matheusfelipeog/beautiful-docs.git) - Pointers to useful, well-written, and otherwise beautiful documentation.
356363
- [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.
357366

358367
### Formats
359368

360369
- Converters
361370
- [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.
362372
- [Markdown](https://www.wikiwand.com/en/Markdown) - A lightweight markup language for creating formatted text using a plain-text editor.
363373
- [MarkText](https://github.com/marktext/marktext) - A simple and elegant markdown editor, available for Linux, macOS and Windows.
364374
- [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.
392402
- [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.
393403
- [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.
394404

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+
395409
### DocOps
396410

397411
- [DocOps Collection](https://doctoolhub.com/collection/docops/) - These articles offer an introduction to the concept of DocOps.

0 commit comments

Comments
 (0)