Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
awesome-technical-writing-learning
😎 A curated list of awesome and free resources about technical writing.
https://github.com/wongyah/awesome-technical-writing-learning
- Google Technical Writing Courses for Engineers - Practical technical writing course for beginners, with examples and metaphors familiar to programmers.
- Google Technical Writing Courses for Engineers
- GitLab Technical Writing Fundamentals Course - four introductory videos about the topic types, grammars, and style requirements for GitLab documentation.
- Coursera: Introduction to Technical Writing - Systematic introduction to technical writing, including the features, workflow, software and tools, history and futures, etc.
- Software Technical Writing: A Guidebook - A technical writer at a computer vision startup talks about his daily work in every detail.
- Documentation APIs: A Guide for Technical Writers and Engineers - Tom Johnson, a senior technical writer at Google and the founder of the [I’d Rather Be Writing](https://idratherbewriting.com/) blog, teaches you how to write API documentation step by step.
- Documentation Guide - Living guide around best practices for creating software documentation, developed and maintained by the [Write the Docs](https://www.writethedocs.org/) community.
- Developing Quality Technical Information: A Handbook for Writers and Editors - One of the must-read books for technical writers. It demonstrates technical writing guidelines with original and revision examples, published by IBM Press.
- Open Technical Communication - Open textbook in its 4th rendition, authored by five professionals at Kennesaw State University.
- Google Technical Writing Courses for Engineers
- ASD-STE100 Simplified Technical English - An international specification widely used in the aerospace and defense industry and other manufacturing industries, containing a set of writing rules and a controlled dictionary.
- The IBM Style Guide - First published by IBM Press in 2011. It emphasizes a helpful, direct, and authoritative tone and topic-based writing (DITA).
- Red Hat Technical Writing Style Guide - For all kinds of technical documentation, including training and examination content. It emphasizes a formal writing style, with the IBM Style Guide as the preferred reference.
- Red Hat Supplementary Style Guide for Product Documentation - Supplementary to the IBM Style Guide. It provides format examples in AsciiDoc.
- Microsoft Writing Style Guide - For computer technology and software documentation. It emphasizes a warm and relaxed conversational voice.
- Google Developer Documentation Style Guide - For software documentation. It emphasizes a casual and natural conversational tone with specific format recommendations for HTML and Markdown.
- GitLab Documentation Style Guide - For open source software documentation written in Markdown. It emphasizes topic-based writing and format guidelines for Markdown.
- SUSE Documentation Style Guide - For software documentation. It emphasizes a professional tone and comprehensive markup reference for DocBook.
- Apple Style Guide - For Apple materials, nothing special.
- University of Oxford Style Guide Quick Reference - One-page quick reference guide with the most commonly requested information.
- University of Oxford Style Guide - Thirty-page style guide for writing and formatting documents consistently.
- Chicago Manual of Style - Over 1000 pages. It has been published continuously since 1906 and now is in its 17th edition (subscription required).
- AMA Manual of Style - For medical and scientific publishing. It has been published continuously since 1962 and now is in its 11th edition (subscription required).
- American Heritage Dictionary
- Merriam-Webster Dictionary
- Grammarly - Online grammar checker that automatically evaluates writing quality.
- QuillBot - Online grammar checker and rewriting tool.
- LanguageTool - AI-based spelling, style and grammar checker.
- ChatGPT - AI chatbot developed by OpenAI.
- Tongyi Qianwen - ChatGPT-like chatbot developed by Alibaba, one of China's largest technology companies.
- Free Readability Checker - For web pages (URL) and texts.
- Readability Formulas - For documents (.txt, .pdf, or .docx) and texts.
- Wordcalc - For texts only.
- Technical Illustration in the 21st Century: A Primer for Today's Professionals - White paper produced by Bettina Giemsa at PTC.
- The State of Technical Illustration and Documentation - Survey report on technical illustration and documentation market, conducted by Corel in 2022.
- Arbortext IsoDraw Data Sheet - Commercial software for technical illustrations, developed by PTC.
- SOLIDWORKS Composer - Commercial software for technical illustrations, developed by SolidWorks.
- XVL Studio 3D CAD Corel Edition - Commercial software for technical illustrations, developed by CorelDRAW.
- XVL Technical Illustration Suite - A suite of commercial software for technical illustrations, developed by Lattice Technology.
- Markdown Guide - Concise, barebones guide for Markdown beginners.
- John Gruber's Markdown Documentation
- Dillinger - In-browser Markdown editor. It can create new files, export files to Markdown, HTML, or PDF, synchronize with GitHub, Google Drive, or Dropbox repositories, etc.
- StackEdit - In-browser Markdown editor with rich functions. It can create new files or folders, export the files to Markdown or HTML, synchronize with GitHub, Google Drive, or Dropbox accounts, etc.
- Visual Studio Code (VS Code) - Code editor developed by Microsoft, with built-in Markdown preview and many Markdown extensions.
- Markdown All in One - An extension to enrich Markdown features in VS Code, such as automatic creation of table of contents, auto completions, printing Markdown files to HTML.
- Markdown Table Maker - An extension to generate Markdown tables in an easy and intuitive way.
- Markdown PDF - An extenstion to convert Markdown files to PDF, PNG, JPEG, or HTML.
- Markdown Preview Enhanced - An extension to enrich Markdown features in Atom and VS Code, featuring the integration of Pandoc.
- the controversy over Markdown
- GitHub Docs: Writing on GitHub - Basic Markdown syntax supported on GitHub.
- GitHub Flavored Markdown Specification
- Markdown DITA Syntax - Markdown styntax supported by DITA Open Toolkit, which is the most commonly used engine for DITA publishing.
- MDITA Syntax - Markdown syntax for Lightweight DITA supported by DITA Open Toolkit, which is the most commonly used engine for DITA publishing.
- Pandoc's Markdown - Markdown syntax of Pandoc, a universal document converter, which can convert between various formats.
- kramdown Quick Reference - Markdown syntax of kramdown, which is the default Markdown parser for Jekyll.
- Awesome Markdown
- Introduction to reStructuredText
- A ReStructuredText Primer - Informal introduction to reStructuredText, authored by Richard Jones.
- reStructuredText Primer - Brief introduction to reStructuredText in Sphinx documentation.
- Online reStructuredText editor
- Visual Studio Code (VS Code) - Code editor developed by Microsoft.
- reStructuredText - An extension to provide rich reStructuredText language support in VS Code.
- reStructuredText Syntax Highlighting - An extension to provide rich syntax highlighting and non-intrusive section navigation for reStructuredText in VS Code.
- Quick reStructuredText - Online cheatsheet for reStructuredText syntax.
- reStructuredText Cheatsheet - Downloadable two-page cheatsheet for reStructuredText syntax.
- reStructuredText Markup Specification - Detailed technical specification for reStructuredText, authored by David Goodger.
- LearningDITA - Nine game-based courses for DITA beginners, developed and maintained by Scriptorium.
- DITA for the Impatient - Short DITA tutorial to teach the basics of DITA, developed by Hussein Shafie at XMLmind Software.
- DITA-aware XML editor
- DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA - A practical book about how to write effective technical information in DITA, published in 2011 by IBM Press (not a free resource).
- The DITA Style Guide: Best Practices for Authors - Written in DITA 1.1 by Tony Self.
- DITA Mini Manual - Mini owner's manual that published in 1960s rewritten in DITA.
- Pilot Training Mitchell Bomber - A pilot training manual (aviation document) rewritten in DITA.
- LwDITA Code Samples - Various manuals of a 1970s computer rewritten in Lightweight DITA.
- DITA Glossary Example - A book named *On Yacht Sailing* rewritten in DITA to demontrate how to implement glossories.
- DITA Version 1.3 - The latest official specifications for DITA, which was released on Jun 19, 2018.
- Lightweight DITA: An Introduction Version 1.0 - The Committee Note 02 for Lightweight DITA, which was approved on Oct 30, 2018.
- DITA Specification - The official repository for the source files of the DITA specification developed and maintained by the DITA Technical Committee.
- Leightweight DITA Specification - The official repository for source files of the Lightweight DITA specification developed and maintained by the Lightweight DITA Subcommittee.
- DITA Specializations - The official repository for DITA specializations that were developed by the DITA Technical Committee, but are no longer part of the DITA standard.
- S1000D Specifications - All versions of official specifications for S1000D.
- ATA Spec 1000BR: Civil Aviation Business Rules for S1000D - An implementation of S1000D specification in civil aviation industry, which can not be accessd for free.
- S1000D DIG Business Rules - An implementation of S1000D specification in the defense industry.
- The Shipdex Protocol: Issue 2.3 - An implementation of S1000D specification in the shipping industry.
- Americans with Disabilities Act of 1990, As Amended
- Rehabilitation Act of 1973: Section 508 (Federal Electronic and Information Technology)
- 美国508无障碍法案
- European Accessibility Act: Directive (EU) 2019/882 on the accessibility requirements for products and services
- European Accessibility Act Summary: Accessibility of products and services
- 中华人民共和国无障碍环境建设法
- Web Content Accessibility Guidelines (WCAG)
- Authoring Tool Accessibility Guidelines (ATAG)
- User Agent Accessibility Guidelines (UAAG)
- GB/T 37668-2019：信息技术 互联网内容无障碍可访问性技术要求与测试方法
- Accessible Rich Internet Applications (WAI-ARIA)
- European Accessibility Act: A Guide to Compliance
- 信息无障碍研究会：无障碍生活指南
- Regular Expressions: The Complete Tutorial - Easy-to-understand and practical book for regex beginners.
- Regex 101 - Online tool to build, test and debug regexes.
- RegExr - Online tool to learn, build and test regexes.
- Regular Expression Language: Quick Reference - Quick reference for regexes from Microsoft.
- Regular Expression Syntax Cheat Sheet - Cheat sheet for regexes in the JavaScript Guide from MDN Web Docs.
- XSLT Tutorial - For XSLT beginners. It was developed by W3Schools.
- XSLT Version 2.0: Second Edition - The latest official specification for XSLT, released on Mar 30, 2021.
- XSLT Version 3.0 - The official specification for XSLT 3.0, released on Jun 8, 2017.
- XPath Tutorial - For XPath beginners. It was developed by W3Schools.
- XPath 3.1 - The latest official specification for XPath, released on Mar 21, 2017.
- XSL-FO Tutorial - For XSL-FO beginners. It was developed by W3Schools.
- XSL-FO Tutorial - Learn-by-example tutorial for XSL-FO beginners. It provides a series of examples working in [XEP](https://www.renderx.com/tools/xep.html).
- XSL Version 1.1 - The lastest official specification for XSL-FO, released on Dec 05, 2006.
- PowerShell 101 - Book for PowerShell beginners. Its content is open to public by Microsoft on its website.
- Everything You Want to Know about … - A series of articles about PowerShell, collected from the [PowerShell Explained](https://powershellexplained.com/) blog by Microsoft.
- PowerShell Documentation - The official documentation for PowerShell 7.4.
- Awesome PowerShell
- Pro Git
- Learn Git
- Git Cheat Sheets
- Git Reference
- I'd Rather Be Writing
- DITA Writer
- JustWriteClick
- Everything Technical Writing
- James' Coffee Blog
- Write the Docs Podcast
- I'd Rather Be Writing Podcasts
- The Content Wrangler
- Quark
Programming Languages
Keywords
markdown
4
list
2
awesome-list
2
awesome
2
visual-studio-code
2
plantuml
2
mermaid
2
vscode-extension
2
pdf
1
vscode-markdown
1
vscode
1
atom
1
atom-package
1
katex
1
markdown-editor
1
mathjax
1
pandoc
1
toc
1
markdown-tables
1
commonmark
1
gfm
1
markdown-table
1
windows-powershell
1
tutorial
1
powershell-ise
1
powershell-cmdlets
1
powershell
1
linux-powershell
1
guides
1
sphinx-preview
1
sphinx-documentation
1
sphinx-doc
1
sphinx
1
snippets
1
restructuredtext
1
python3
1
python2
1
python
1
preview
1
live-preview
1
linter
1
documentation-tool
1
resources
1