I'm slightly worried that this may be a duplicate, but I have searched the site and every question that I can find seems to be more focused on functional specifications rather than technical ones. I'm looking for information on how to communicate how something should be done, rather than what should be done. I think at the simplest leve...
I've seen a few questions around here saying that there's no need to write a beefy Technical Specification if the Functional Specification has all of the functionality. What about situations where the client has provided a Functional Specification and you need to turn around a Technical Specification from that document? I understand tha...
I need to prepare a proposal for the technical specification in the development of a new project, what I've done before was to include the following: Platform The primary technology and secondary ones the system will be programmed OS Target The target in which the system will run Application Server in the case of a web application Appl...
Say I come up with some super-duper way of representing some data that I think would be useful for other people to know about and use. Assume I have a 'spec' in some form, even if it might not be a completely formal one: ie, I know how this file format will work already. How would I then go about releasing this spec to get comments and ...
Hi All, I am looking for a decent tech spec documentation template for a MOSS implementation. If anyone can share any existing document template then it would really help me. Thanks Bhaskar ...
Couldn't we write the design documentation for source code within the source itself? I suppose like Doxygen but with the focus taken away from implementation towards design. Essentially (and rather excitingly) you have a nice big chunk of markdown at the end of your source file. Each time I create a new source file (and begin writing in...
I am spending my Monday morning writing up some documentation, and have found a situation where I need to a word to refer to data which is not metadata. The usual term "data" isn't specific enough in this case, because both metadata and the not-metadata are required parameters (so they're really both "data"). The documentation is essen...