infovore + documentation   12

Brendan Dawes - Using a Git Repo to create a physical document of the work
"All my work is tracked through a Git repository — a way to track code changes over time, complete with comments on why something has changed or what that commit was about. In conduction with that I take timestamped screenshots. These two things combined — words and image — have the side-effect of creating a document of the making process. So with that in mind I have begun to take those words and images and compile them chronologically into small books, both for myself and the client, as an historical record of how something went from A to B." Very good. I really like (in general) the idea of Project Books.
brendandawes  git  documentation  history 
8 days ago by infovore
Roy's Postcards
"It's 1981. Roy Richardson is a manager at a Los Angeles computer company. A devout Mormon, he has a two-year-old son, with two daughters yet to be born. He has a little over ten years to live.

I was that two-year-old and Roy was my father. I grew up without him, knowing the outlines of his life but not the details. In 2006, at my mother's house, I found three boxes of details." Leonard never fails to surprise and amaze. This is wonderful.
leonardr  postcards  family  history  writing  documentation 
january 2012 by infovore
JavaScript Garden
"JavaScript Garden is a growing collection of documentation about the most quirky parts of the JavaScript programming language. It gives advice to avoid common mistakes, subtle bugs, as well as performance issues and bad practices that non-expert JavaScript programmers may encounter on their endeavours into the depths of the language." This looks really, really good. Alas, unlike Phil, I'm still not quite fully up-to-speed on Prototypes, but it's a great piece of documentation nontheless.
javascript  reference  documentation  programming 
april 2011 by infovore
Readme Driven Development
"Consider the process of writing the Readme for your project as the true act of creation. This is where all your brilliant ideas should be expressed. This document should stand on its own as a testament to your creativity and expressiveness. The Readme should be the single most important document in your codebase; writing it first is the proper thing to do." I like this: after all, a README is basically the story you tell about your software. Why not write it before the software exists?
documentation  development  readme  process 
august 2010 by infovore
Rails 3 Reading Material | Medium eXposure
Great round-up of all the stuff out there about Rails 3. If you're as behind as I am on preparing for this, there's some really good stuff here; nice to have it all in one place.
ruby  rails  rails3  documentation  tutorials 
february 2010 by infovore
pman -- create, print, save, view PDF man pages
"convert man pages into PDF documents and save them to a specified directory; (batch) print or view PDF man pages from the command line". Which is, you know, clever.
man  manpage  programming  documentation  unix  script  shell  utility 
january 2010 by infovore
Merb Routing in 0.5
"Merb’s routing shiznits needs some serious documentation love. Whilst I have a shot at getting some proper docpatches together here’s an overview of how to use routing in Merb 0.5." Thank god for that - was finding Merb's docs a little patchy in places.
merb  routing  ruby  programming  documentation 
september 2008 by infovore
Front page - APIdock
"APIdock is a web app that provides a rich and usable interface for searching, perusing and improving the documentation of projects that are included in the app." Handy.
api  reference  documentation  doc  ruby  rspec  rails 
august 2008 by infovore
adaptive path » blog » Peter Merholz » Pen(cil) and paper to live prototype - where’d the wireframe go?
"I think the role of the architecture diagram, user flow, and wireframe belongs very much after the fact, after we’ve sketched and prototyped an experience. Those are tools to document what has been agreed through sketching and prototyping. They are not the best means for solving challenging design problems." That seems like a good way of putting it.
documentation  ux  userexperience  design  sketching  prototyping  wireframe  making 
august 2008 by infovore
"ScreenSteps brings simplicity to the labor intensive process of software documentation." Focusing on the screengrab, rather than video, as instruction tool. Could be a nice approach, especially if export is any good.
help  documentation  creation  tool  application  mac  osx 
january 2008 by infovore
Chmox - a Mac OS X CHM viewer
CHM files - compiled HTML - are basically Windows Help files. You need something like this to view them on a Mac.
mac  osx  application  chm  documentation  reader 
april 2007 by infovore
Prototype Javascript Library easing the development of dynamic web applications
Prototype finally has its own website. About bloody time - but it's great to see it being supported so thoroughly.
protoype  javascript  rails  api  documentation  ajax  js  development  programming 
january 2007 by infovore

Copy this bookmark: