technical-writing-template

Writing guide

Provides guidelines and a template structure for writing technical articles about software development topics

unicorn A sample template with guidelines for writing technical articles.

GitHub

501 stars
11 watching
114 forks
last commit: over 1 year ago
Linked from 1 awesome list

technical-writingtemplate

Backlinks from these awesome lists:

Related projects:

Repository Description Stars
alexandrascript/tech-writing-tools Resource collection for technical writers, covering tools, templates, and guidelines for effective writing and documentation 194
lornajane/developer-style-guide Provides guidance for technical writers on documenting complex software topics in an approachable and inclusive manner. 16
sixhobbits/technical-writing A collection of resources and information on technical writing 596
lvarayut/javascript-style-guide A comprehensive guide to writing clean and consistent JavaScript code according to Airbnb's style conventions. 451
cezaraugusto/github-template-guidelines Guidelines for building GitHub templates 237
jamiebuilds/documentation-handbook Best practices for writing approachable and effective documentation 294
stevekwan/best-practices Guides for front-end developers on coding standards and best practices for JavaScript and CSS. 1,704
studentsphere/guide-javascript A comprehensive JavaScript style guide covering best practices and conventions for coding in JavaScript. 0
lvignoli/diapo A presentation template using a minimalistic syntax 50
felipevolpatto/css-style-guide A comprehensive guide to CSS and Sass best practices for maintaining consistency and readability in web development projects. 91
manuscripts/book-starter A basic template for writing a book in plain text with Markdown. 16
zagoli/simple-typst-thesis A template for creating a thesis document with custom headers and page layout using Typst. 45
mitsuruog/javascript-style-guide A JavaScript style guide outlining best practices for writing clean, maintainable code. 331
chamnap/javascript_style_guide A comprehensive style guide for writing clean, maintainable JavaScript code 11
voorhoede/riotjs-style-guide Provides guidelines and best practices for structuring and organizing RiotJS code in teams. 287