#documentation (61 links)
There’s a theory called Information Foraging, which suggests that people follow clues rather than systematically exploring hierarchies.
Peter Pirolli and Stuart Card describe people as information foragers. This is such a rad term for people looking for stuff on the web. Like a badger foraging for small invertebrates, we humans look for signs that useful information might be nearby and constantly decide whether to continue the search.
- suitenumerique/docs github.com
Docs is an open-source text editor: web-native, made for real-time collaboration, cleanly structured documents and sub-documents with full ownership of your data. Built to scale with Django and React.
#blocknotejs#collaborative #django #documentation#g2g #government #knowledge#knowledge-base#mit#mit-license #opensource #reactjs#realtime-collaboration #self-hosted #wiki#yjs #python - Companies Using RFCs or Design Docs and Examples of These blog.pragmaticengineer.com
- 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.
- Don’t say “simply” in your documentation by Jim Fisher | KnowledgeOwl knowledgeowl.com · Archived on
- Antora antora.org
The multi-repository documentation site generator for tech writers who writing in AsciiDoc.
- c8r/kit github.com
Tools for developing, documenting, and testing React component libraries
#cli #components #design-systems #development #documentation#isolation #jsx #library#mdx #react#styleguide #testing #ui #javascript - reactjs/react-docgen github.com
A CLI and library to extract information from React component files for documentation generation purposes.
- TLDR pages tldr-pages.github.io
Simplified and community-driven man pages Usage Run in live demo or your terminal. tldr tar tldr tar command output Installation Install the NodeJS client npm…
- jonathantneal/mdcss github.com
mdcss lets you easily create and maintain style guides with CSS comments using Markdown. Add mdcss to your build tool: Add PostCSS to your build tool: Load…
- jlevy/the-art-of-command-line github.com
Master the command line, in one page
- hackpad hackpad.com
- How GitHub uses GitHub to document GitHub github.com
I basically now have both the simplest and most sophisticated multi-language ebook production and distribution setup on the planet.
Beautiful, if you like this sort of thing.
- ditto chutsu.github.io
A markdown code documentation system, capable of producing documentation similar to Three.js and Backbone.js.
- DevDocs devdocs.io
Combines multiple API documentations in a fast, organized, and searchable interface.
- Brett Jankord – 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 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!
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
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.
Via paul.irish.
- Google JavaScript Style Guide google-styleguide.googlecode.com
Via twoplusfour.
- 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.
Via thegingerbloke.
- 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