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: almost 3 years ago
Linked from 1 awesome list

technical-writingtemplate

Backlinks from these awesome lists:

Related projects:

RepositoryDescriptionStars
alexandrascript/tech-writing-toolsResource collection for technical writers, covering tools, templates, and guidelines for effective writing and documentation194
lornajane/developer-style-guideProvides guidance for technical writers on documenting complex software topics in an approachable and inclusive manner.16
sixhobbits/technical-writingA collection of resources and information on technical writing596
lvarayut/javascript-style-guideA comprehensive guide to writing clean and consistent JavaScript code according to Airbnb's style conventions.451
cezaraugusto/github-template-guidelinesGuidelines for building GitHub templates237
jamiebuilds/documentation-handbookBest practices for writing approachable and effective documentation294
stevekwan/best-practicesGuides for front-end developers on coding standards and best practices for JavaScript and CSS.1,704
studentsphere/guide-javascriptA comprehensive JavaScript style guide covering best practices and conventions for coding in JavaScript.0
lvignoli/diapoA presentation template using a minimalistic syntax50
felipevolpatto/css-style-guideA comprehensive guide to CSS and Sass best practices for maintaining consistency and readability in web development projects.91
manuscripts/book-starterA basic template for writing a book in plain text with Markdown.16
zagoli/simple-typst-thesisA template for creating a thesis document with custom headers and page layout using Typst.45
mitsuruog/javascript-style-guideA JavaScript style guide outlining best practices for writing clean, maintainable code.331
chamnap/javascript_style_guideA comprehensive style guide for writing clean, maintainable JavaScript code11
voorhoede/riotjs-style-guideProvides guidelines and best practices for structuring and organizing RiotJS code in teams.287