Brent Sordyl's blog

MagicRuby presentation: Documentation is freaking awesome

February 8, 2011 by Brent Sordyl 0 Comments

Documentation Formats: RDoc YARD TomDoc TomDoc.rb docco rocco shocco pycco

(Full Story: MagicRuby presentation: Documentation is freaking awesome)

UX Documentation: Answering Why, What and How

January 4, 2011 by Brent Sordyl 0 Comments

Many people don’t see the importance of gathering the necessary explanatory documents that define what you did all throughout your project development. Either that, or they treat the documentation process as a simple putting-together of all the sketches and wireframes generated. We should, nonetheless, give more relevance to this final, whole-project document.

(Full Story: UX Documentation: Answering Why, What and How)

documentation, projectmanagement, ux, web2.0

Rails ERD – Entity-Relationship Diagrams for Rails

October 7, 2010 by Brent Sordyl 0 Comments

Rails ERD is a plugin for Ruby on Rails that generates diagrams based on your Active Record models. Such an entity-relationship diagram gives an overview of your models and how they are associated. Browse through example diagrams, or read the installation instructions.
(Link: Rails ERD – Entity-Relationship Diagrams for Rails)

documentation, erd, rubyonrails

RailRoad diagrams generator

September 11, 2010 by Brent Sordyl 0 Comments

RailRoad is a class diagrams generator for Ruby on Rails applications. It’s a Ruby script that loads the application classes and analyzes its properties (attributes, methods) and relationships (inheritance, model associations like has_many, etc.) The output is a graph description in the DOT language, suitable to be handled with tools like Graphviz.
(Link: RailRoad diagrams generator)

diagram, documentation, rubyonrails

YARD – A Ruby Documentation Tool

September 11, 2010 by Brent Sordyl 0 Comments

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be? exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD’s notable features.
(Link: YARD – A Ruby Documentation Tool)

documentation, ruby

ruby

RailRoad generates Rails documentation – GitHub

July 14, 2010 by Brent Sordyl 0 Comments

RailRoad generates models and controllers diagrams in DOT language for a Rails application.
(Link: RailRoad generates Rails documentation – GitHub)

documentation, dot, rubyonrails

DITA – Darwin Information Typing Architecture

April 28, 2009 by Brent Sordyl 0 Comments

The Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering technical information. This architecture consists of a set of design principles for creating “information-typed” modules at a topic level and for using that content in delivery modes such as online help and product support portals on the Web.

At the heart of DITA, representing the generic building block of a topic-oriented information architecture, is an XML document type definition (DTD) called “the topic DTD.” The extensible architecture, however, is the defining part of this design for technical information; the topic DTD, or any schema based on it, is just an instantiation of the design principles of the architecture.
(Link: DITA – Darwin Information Typing Architecture)

content, dita, documentation, xml