ohskylab + documentation 36
Our API docs are now hosted on Github - 37Signals
2 days ago by ohskylab
Looks like a good example of how to do it.
web
api
documentation
from instapaper
2 days ago by ohskylab
Designing Great API Docs
15 days ago by ohskylab
"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!"
web
api
apidesign
documentation
15 days ago by ohskylab
DocumentUp
january 2012 by ohskylab
"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."
web
documentation
git
github
html
markdown
january 2012 by ohskylab
Transifex
january 2011 by ohskylab
"An open service allowing people to collaboratively translate software, documentation and other types of projects."
documentation
translation
i18n
from delicious
january 2011 by ohskylab
Pandoc
november 2010 by ohskylab
"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
tools
conversion
converter
html
markup
markdown
latex
text
documentation
november 2010 by ohskylab
Python Module of the Week
february 2010 by ohskylab
"The Python Module of the Week series, or PyMOTW, is a tour of the Python standard library through short examples." Nice.
development
documentation
python
tips
reference
february 2010 by ohskylab
Advanced Bash-Scripting Guide
february 2010 by ohskylab
"An in-depth exploration of the art of shell scripting"
programming
reference
scripts
shell
sysadmin
bash
documentation
february 2010 by ohskylab
Semantic Versioning
december 2009 by ohskylab
"I propose a simple set of rules and requirements that dictate how version numbers are assigned and incremented. For this system to work, you first need to declare a public API [...] Once you identify your public API, you communicate changes to it with specific increments to your version number. Consider a version format of X.Y.Z (Major.Minor.Patch). Bug fixes not affecting the API increment the patch version, backwards compatible API additions/changes increment the minor version, and backwards incompatible API changes increment the major version."
development
programming
api
semantics
documentation
versioning
scm
semantic
december 2009 by ohskylab
Zend Framework: Documentation
december 2009 by ohskylab
"Zend Framework Coding Standard for PHP"
php
zend
web
development
standards
programming
reference
documentation
december 2009 by ohskylab
Pro Git - Pro Git Book
july 2009 by ohskylab
"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
git
vcs
creativecommons
documentation
dvcs
july 2009 by ohskylab
Complete Introduction to git
july 2009 by ohskylab
"This short tutorial shall attempt to explain the git system to people
who have no, or minimal experience on SCMs and version control tools."
git
vcs
development
collaboration
documentation
dvcs
who have no, or minimal experience on SCMs and version control tools."
july 2009 by ohskylab
Flickr Code
april 2008 by ohskylab
"Your one-stop shop for information, gossip and discussion with the Flickr developer community"
flickr
api
development
documentation
web
april 2008 by ohskylab
Slashdot | Best Practices For Process Documentation?
january 2008 by ohskylab
"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?"
documentation
process
wiki
development
slashdot
management
january 2008 by ohskylab
Main Page - Facebook Developers Wiki
june 2007 by ohskylab
"A reference for developers interested in the Facebook Platform."
facebook
api
wiki
development
documentation
web
june 2007 by ohskylab
Maven - Maven: The Definitive Guide (1.0 Alpha 1) - Table Of Contents
may 2007 by ohskylab
"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."
maven
java
programming
documentation
development
book
reference
may 2007 by ohskylab
Google Maps API Tutorial
may 2007 by ohskylab
"Intended to help you create your own interactive maps using the Google API."
googlemaps
tutorials
maps
api
javascript
documentation
web
may 2007 by ohskylab
IA One Sheeters
may 2007 by ohskylab
"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."
ia
usability
documentation
web
ux
may 2007 by ohskylab
Shape Shed - Journal - Default Styles for CSS
april 2007 by ohskylab
Don't particularly like the methods but always interesting to see what other people do...
css
web
development
documentation
april 2007 by ohskylab
Garrett Dimon / Documenting Interface Design
january 2007 by ohskylab
"I’ve done my best to migrate away from traditional documentation methods and find ways that actual help others visualize what the end product should look like."
documentation
design
ia
usability
web
ued
january 2007 by ohskylab
JQuery
june 2006 by ohskylab
Cody's jQuery examples
javascript
jquery
documentation
example
demo
web
june 2006 by ohskylab
related tags
24ways ⊕ api ⊕ apidesign ⊕ archive ⊕ bash ⊕ book ⊕ cheatsheet ⊕ collaboration ⊕ conversion ⊕ converter ⊕ creativecommons ⊕ css ⊕ demo ⊕ design ⊕ development ⊕ django ⊕ documentation ⊖ dvcs ⊕ example ⊕ facebook ⊕ flickr ⊕ generator ⊕ git ⊕ github ⊕ google ⊕ googlemaps ⊕ guide ⊕ html ⊕ i18n ⊕ ia ⊕ instruction ⊕ java ⊕ javascript ⊕ jquery ⊕ latex ⊕ learning ⊕ management ⊕ manuals ⊕ maps ⊕ markdown ⊕ markup ⊕ maven ⊕ mediawiki ⊕ php ⊕ process ⊕ programming ⊕ python ⊕ reference ⊕ robots.txt ⊕ scm ⊕ scripts ⊕ search ⊕ semantic ⊕ semantics ⊕ seo ⊕ shell ⊕ slashdot ⊕ standards ⊕ styleguide ⊕ sysadmin ⊕ text ⊕ tips ⊕ tool ⊕ tools ⊕ translation ⊕ tutorials ⊕ ued ⊕ usability ⊕ ux ⊕ vcs ⊕ versioning ⊕ via:paul.irish ⊕ via:thegingerbloke ⊕ via:twoplusfour ⊕ web ⊕ wiki ⊕ zend ⊕Copy this bookmark: