#documentation (54 links)
- Companies Using RFCs or Design Docs and Examples of These blog.pragmaticengineer.com
- BrandGuide brandguide.page
- Code With Engineering Playbook microsoft.github.io
- Diátaxis Framework diataxis.fr
The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.
- Design Docs at Google industrialempathy.com
One of the key elements of Google's software engineering culture is the use of defining software designs through design docs. These are relatively informal documents that the primary author or authors of a software system or application create before they embark on the coding project. The design doc documents the high level implementation strategy and key design decisions with emphasis on the trade-offs that were considered during those decisions.
- AsciiDocLIVE asciidoclive.com
<blockquote>free online AsciiDoc editor.</blockquote>
- Antora antora.org
<blockquote>The multi-repository documentation site generator for tech writers who writing in AsciiDoc. </blockquote>
- hackpad hackpad.com
- How GitHub uses GitHub to document GitHub github.com
<blockquote>I basically now have both the simplest and most sophisticated multi-language ebook production and distribution setup on the planet.</blockquote>
Beautiful, if you like this sort of thing.
- ditto chutsu.github.io
<blockquote>A markdown code documentation system, capable of producing documentation similar to Three.js and Backbone.js.</blockquote>
- DevDocs devdocs.io
<blockquote>Combines multiple API documentations in a fast, organized, and searchable interface.</blockquote>
- DAUX.IO daux.io
<blockquote>The Easiest Way To Document Your Project</blockquote>
- Brett Jankord – Style Guide Boilerplate brettjankord.com
- Style Guide Boilerplate brettjankord.com
- The Hitchhiker’s Guide to Python! — pythonguide 0.0.1 documentation docs.python-guide.org
- Our API docs are now hosted on Github - 37Signals 37signals.com
Looks like a good example of how to do it.
- Designing a RESTful Web API publish.luisrei.com
- Designing Great API Docs blog.parse.com
The most important piece of UX for a developer product isn't the homepage or the sign up process or the SDK download. It's the API documentation!
- DocumentUp documentup.com
Parses your readme's markdown into a clean and simple documentation website. Made especially for your gh-pages branch, all you need is a single index.html file that includes the DocumentUp script.
- Knyle Style Sheets — Warpspire warpspire.com
- API design for humans - (37signals) 37signals.com
- Transifex transifex.net
An open service allowing people to collaboratively translate software, documentation and other types of projects.
- Pandoc johnmacfarlane.net
A program for converting between various markup formats. Input formats include markdown, reStructuredText, HTML, and LaTeX; output formats include HTML, LaTeX, ConTeXt, S5, DocBook, groff man, reStructuredText, markdown, and RTF.
- Google JavaScript Style Guide google-styleguide.googlecode.com
- html2wiki - Convert HTML text to wiki markup toolserver.org
- Python Module of the Week doughellmann.com
"The Python Module of the Week series, or PyMOTW, is a tour of the Python standard library through short examples." Nice.
- Bash scripting Tutorial linuxconfig.org
- Advanced Bash-Scripting Guide tldp.org
An in-depth exploration of the art of shell scripting
- Zend Framework: Documentation framework.zend.com
Zend Framework Coding Standard for PHP
- Django gotchas v0.1 documentation djangogotchas.uswaretech.net
- Pro Git - Pro Git Book progit.org
Here you can find the full content of the book, a blog with tips and updates about Git and the book and open source projects related to Git or referenced in the book.
- Complete Introduction to git students.ceid.upatras.gr
This short tutorial shall attempt to explain the git system to people who have no, or minimal experience on SCMs and version control tools.
- AJAX APIs Playground code.google.com
- Django cheat sheet (Mercurytide) mercurytide.co.uk
- Flickr Code code.flickr.com
Your one-stop shop for information, gossip and discussion with the Flickr developer community
- Slashdot | Best Practices For Process Documentation? ask.slashdot.org
I know that this is all a waste of time if there's no follow-through from management. But assuming that the required support is there, how do you guys do process documentation?
- jQuery HTML Documentation Generator jquery.bassistance.de
- Main Page - Facebook Developers Wiki wiki.developers.facebook.com
A reference for developers interested in the Facebook Platform.
Maven is a framework for managing various aspects of a project, providing its own conventions and tools to meet this end and acting as glue for making existing disparate tools work in a tractable and orderly manner.
- Google Maps API Tutorial econym.demon.co.uk
Intended to help you create your own interactive maps using the Google API.
- IA One Sheeters iaonesheeters.com
One-Sheeters are quick and easy marketing tools for information architects. They're like mini brochures to advertise IA deliverables and promote the IA practice in your company.
- Shape Shed - Journal - Default Styles for CSS shapeshed.com
Don't particularly like the methods but always interesting to see what other people do...