In which document do file specifications belong?

Posted by Andrew on Stack Overflow See other posts from Stack Overflow or by Andrew
Published on 2010-05-04T13:46:18Z Indexed on 2010/05/04 13:48 UTC
Read the original article Hit count: 157

Filed under:

file-specification

|

documentation

In which document would a file specification belong? Perhaps this file is used as an input to a third-party system. Would it belong in its own document? Or would it be better to put it in the functional or design spec? Or somewhere else?

When I say file specification, I mean a description of what format the file is (CSV, fixed width, etc), columns, data types, etc.

Also, where should you document how the file is generated? i.e. business rules/algorithms which are used to generate the file.

© Stack Overflow or respective owner

Related posts about file-specification

In which document do file specifications belong?

as seen on Stack Overflow - Search for 'Stack Overflow'
In which document would a file specification belong? Perhaps this file is used as an input to a third-party system. Would it belong in its own document? Or would it be better to put it in the functional or design spec? Or somewhere else? When I say file specification, I mean a description of what… >>> More
CRC for PNG file format

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi All, I need to read a PNG file and interpret all the information stored in it and print it in human readable format. While working on PNG, i understood that it uses CRC-32 for generating checksum for each chunk. But I could not understand the following information mentioned on the PNG file specification… >>> More
Import Text Specification in Access Database

as seen on Stack Overflow - Search for 'Stack Overflow'
We are using C#.net & use access database code for import of text file specification into access table is there any access database limit for this action, as we may have records 5 lac (500,000) ,will this process work for huge records?? If No then how can we handle huge records insertion in… >>> More
TFS 2010 Build: Dealing with the API restriction error

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
Recently I’ve come across this error a couple of times when running builds that exeucte unit tests using Test containers: API restriction: The assembly 'file:///C:\Builds\<path>\myassembly.dll' has already loaded from a different location. It cannot be loaded from a new location within the… >>> More
Defining a SPI in Clojure

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm looking for an idiomatic way(s) to define an interface in Clojure that can be implemented by an external "service provider". My application would locate and instantiate the service provider module at runtime and delegate certain responsibilities to it. Let's say, for example, that I'm implementing… >>> More

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More