O'Reilly Community

BROWSE: Most Recent | Popular Tags | Search:

Tags > documentation

5 Tips For Documenting Code

By Jesse Freeman
November 2, 2009

Advanced Flash Tactics or AFTs are techniques that come from deep within the Flash Art Of War, the oldest Flash military treatise in the world. In this AFT I will go over - 5 Tips for Documenting Code. Documenting code is not high on many people's lists of things todo. Most of the time it is boring, repetitive, and time consuming. If you want to get better at documenting your own code then this is the post for you. I have 5 simple rules to follow while coding to make the process easier.

Worldwide Lexicon: matching up technologies and culture to end the language barrier

By Andy Oram
September 22, 2009

Essays by Brian McConnell of World Wide Lexicon and Ethan Zuckerman of Global Voices describe the technical and cultural sides of developing communities of volunteer translators.

World Wide Lexicon Toolbar changes the reading experience for the other 99% of web pages

By Andy Oram
August 25, 2009

World Wide Lexicon Toolbar meets my criterion for a piece of critical infrastructure: after two days with it I can't get along without it, and I plan to avoid any browser that doesn't have it installed.

Four roles for publishers: staying relevant when you are no longer a gatekeeper

By Andy Oram
June 17, 2009

In many areas of publishing, there are enormous resources of free online material and innumerable forums where individuals can quickly and conveniently post their own observations. Since we are no longer gatekeepers, publishers have to focus on how we add quality.

Challenges from a book sprint: the great things about ignorance and disorder

By Andy Oram
March 24, 2009

e tried to write a conventional computer manual in two days, and the experience has made me reconsider the conventions of computer manuals. The computer field is still in the kindergarten stage of exploring serious questions of how people learn, questions at the center of psychology and pedagogy for many decades. Even those disciplines don't quite get it, because they're fumbling with the instant messaging culture that gives us so many more tools today for learning together.

Free book, community gathering, Richard Stallman to write foreword

By Andy Oram
March 19, 2009

Update to my posting about a book-writing project this coming weekend in Cambridge, Mass. (March 21-22). RMS will write a foreword for the book.

Croudscribing: Can the free software community create a book in two days?

By Andy Oram
March 15, 2009

Next weekend, March 21-22, in Cambridge, Massachusetts, the Free Software Foundation and FLOSS Manuals are coordinating volunteers to write a book about the command line in two days.

Writing Technical Documentation with Sphinx, Paver, and Cog

By Doug Hellmann
February 2, 2009

An open source tool chain for producing technical articles.

Education of software project members: New API posted

By Andy Oram
December 6, 2008

Over the past month I've made a few significant updates to my API for educating software project members.

Apple's Software User Guide Diet

By Jochen Wolters
September 30, 2008

AApple's handheld devices are an example for miniaturization at work: with every new release, iPods have gotten a little smaller, and "incredibly thin" is the new "insanely great." Unfortunately, Apple has also miniaturized some of their software user guides

Proposed API for tools to help educate computer users online (take two)

By Andy Oram
August 28, 2008

More detail at t\ake one. What's new? A lot more detail in the parameters. Developing that detail allows me to create a tighter, more consistent, and ultimately more powerful API.

Open Source convention wrap-up (2008)

By Andy Oram
August 25, 2008

The computer industry is certainly not recession-proof, but the Open Source convention that's just wrapping up had more attendees than last year (we were up to about 2000), and discussions about starting businesses based on open source seemed to take place everywhere. And I don't mean just free software: open source concepts apply to hardware, creative content, and other materials. Big topics included virtualization and the next stage of virtualization: cloud computing. Perhaps those are the practitioner's solution to multicores.

Documenting Conventions

By Simon St. Laurent
August 25, 2008

"Convention over configuration" is a great way to write code - but a lot harder to explain when it comes time to write documentation.

Proposed API for tools to help educate computer users online

By Andy Oram
August 14, 2008

For several years I have recommended improvements to the tools that software projects use to answer technical questions and provide documentation, such as wikis and mailing lists. My latest contribution is a draft of an API that could be implemented in tools such as IDEs and content management systems.

A Guide to iPhone Dev Documentation

By Matt Twomey
July 3, 2008

Among all of the iPhone documentation published, how do you separate the wheat from the chaff? In this article, Matt Twomey highlights some of the documentation from Apple that he has found most accessible, but at the same time particularly useful.

1 to 15 of 15