InfoQ Homepage Documentation Content on InfoQ
-
Two Types of Agile Documents - No More, No Less!
The Agile Manifesto suggests “ Working software over comprehensive documentation”. This has led many teams to believe that there is no need for documentation in Agile projects. Critics of Agile use limited documentation in Agile to showcase the weakness of Agile methodologies. Eelco Gravendeel suggested that there are just two types of documentation in Agile.
-
Character Encodings and M17N Explained
James Edward Gray II wrote a series of posts on character encoding in Ruby, providing various tricks and detailed explanations to make you ready for Ruby 1.9.
-
Fluent NHibernate Has a Wiki
Fluent NHibernate is an alternative to using XML mappings in NHibernate. Fluent NHibernate is using a fluent interface allowing you to define mappings in code instead of XML. Some people in the community have complained about the lack of documentation for Fluent NHibernate and as a response James Gregory recently announced the official Wiki for Fluent NHibernate.
-
Article: Subbu Allamaraju on Describing RESTful Applications
If servers control their own namespace without a fixed resource hierarchy, how do clients, and more importantly client developers, get to learn or discover URIs of resources? In a new article, Subbu Allamaraju discusses how to describe a RESTful API, focusing on using hypermedia instead of an out-of-band description format such as WADL or WSDL 2.0.
-
YARD - Code Metadata And Documentation Generation for Ruby
YARD is an extensible tool to provide metadata about Ruby code using Javadoc-style meta tags. The metadata includes optional type annotations using either type names or structural type information. We look at YARD and how Merb and the Ruby In Steel IDE use similar approaches for optional type annotations.
-
Sandcastle Source Released
Last month there was an uproar over hosting Sandcastle, a closed-source tool, on the open source site CodePlex. In response to customer demands, Microsoft has decided to release the source code for Sandcastle.
-
SQL Server 2008 RC0 Has Been Released to the Public
Microsoft has released SQL Server 2008 RC0 to the general public.
-
Interview: Markus Voelter about Software Architecture Documentation
InfoQ interviewed Markus Voelter about the importance of writing software architecture documentation and the problems noticed by him when it comes to creation of useful software design documents.
-
New Resources for the Software Architecture
Several new resources are available for the software architect. Simon Brown and Kevin Seal have made available a set of guidelines for creating software architecture documentation. Mike Kavis also put together a framework to help guide the architect in dealing with the change that new architecture can bring.
-
Sandcastle: Generate .NET API Documentation
Sandcastle is a Microsoft tool used to create MSDN like API documentation by reflecting over the source code assemblies and adding the XML comments included in the code. A new version of Sandcastle has just been released on CodePlex.
-
Rails 2.0 - What's a Newbie to Do?
Rails 2.0 is out - but some of the standard books and tutorials haven't been updated to this version yet. Trying to learn about Rails with a Rails 1.2 book or tutorial, but running Rails 2.0 is bound to cause some frustration. We look at the best approach to tackle this.
-
Ruby 1.9 released
Ruby 1.9 has just been released, bringing a host of new features and improvements. Speed improvements come from the new YARV VM, concurrency features were updates with native threading and Fibers, and language changes such as a new Hash literal syntax tighten the language. We take a look at some of the features and where to find information about Ruby 1.9.
-
Why API design matters
API design affects all developers. Some APIs are a pleasure to work with, others are annoying and yet others are downright frustrating. But what's makes the difference? Which qualities make one API easy to use and another hard? The ACM Queue recently published an article by Michi Henning about API design; an article that analyzes these aspects.
-
Do Agile Methods Require Documentation?
Some believe that agile methods do not require (or cannot support) documentation of any kind. Ian Cooper examines this belief against the Agile manifesto and against specific agile methods.
-
Writing Maintainable Code
Sam Gentile, Oren Eini (aka Ayende), and Frans Bouma have an ongoing debate in the .NET community about how to write maintainable code, which several others have joined. The debate mainly focuses on the question, if Test-Driven-Development (TDD), O/R-Mappers (ORM), Model-View-Presenter/Controller (MVP/MVC), and other best-practices help to improve the maintainability of software.