InfoQ

InfoQ

Topic/Tag specific view

Documentation Content on InfoQ


Latest featured content about Documentation

Feature Injection: three steps to success

Topics
Agile,
Agile Techniques

Often Customers provide half baked solutions with no linkage to value. An Agile team needs examples linked to the Business Value they provide. Feature Injection is a process that takes a half baked solution identifies the Business Value it provides and then produces a set of examples driven from that value.

News about Documentation

Scala+GWT Brings Scala to the Browser, New Documentation Site and Scala Days 2012 Announced

Topics
Compilers,
Javascript,
Web Frameworks

Scala+GWT makes it possible to run Scala in the browser, the latest release supports most of the language. The new Scala+GWT Eclipse plug-in uses GWT's development mode for faster turnaround. Also, the Scala team announced a new documentation website and the date for 2012's Scala Days conference.

Mashery Redefines API Documentation with Interactive I/O Docs

Topics
REST,
Tools,
SOA

Mashery introduces a new generation of API documentation tooling with I/O Docs. I/O Docs takes the drudgery out of verbose API docs and enlivens the experience through live API calls within the documentation. In this news item, we talk to Neil Mansilla to understand the motivation for building this tool, its current state and its future.

Packaging Visual Studio Help Files

Topics
IDE,
.NET

If you are offering a commercial or open source library for .NET developers, including an integrated help file is a great way to show your professionalism. It can also be handy when working on a framework that is reused across a company’s internal applications. In a recent article Jeff Braaten explains the process of creating Visual Studio Help Files.

Articles about Documentation

Implementation Decision Rationales – Program Comprehension in Agile

Topics
Delivering Quality,
Maintenance,
Agile,
Programming

Given the fact that the bulk of a developer's work is maintaining and enhancing existing code, Fabian Kiss makes the case for a lightweight approach to documenting the rationale and decision process behind design decisions to help later developers tie the source code syntax to its meaning in the application domain. Using simple tags and clearly thought out rationale to provide just-enough value.

Describing RESTful Applications

Topics
REST,
Design,
SOA

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.

Presentations about Documentation

More Than Just A Commodity

Topics
Business,
Communication,
Teamwork

Joe Kuemerle introduces the developer to the business side of development starting from the premise that it is not enough to be technologically savvy to be successful in a software organization.

The Code is the Design

Topics
Programming,
Architecture,
Design

Mark Haskamp supports the idea that source code is the design blueprint and entire the documentation of a software product.

Interviews about Documentation

Markus Voelter about Software Architecture Documentation

Topics
Modeling,
Architecture

During OOPSLA 2007, InfoQ interviewed Markus Voelter asking him about creating software architecture documentation. Many people mention UML when they are asked about software design documentation, but Markus has a different take on that. He thinks that we should be using models which can be processed with tools which can validate or invalidate them.