Stack Exchange Network

Stack Exchange network consists of 174 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

A specification (often abbreviated as spec) is an explicit set of requirements to be satisfied by a material, product, or service.

2
votes
1answer
76 views

Differentiating Between ASCII and Unicode in File Spec

I am developing against a file spec that lists the data type for certain fields as CHAR(<length>) The spec is for a fixed width flat file. In most cases, possible values to populate the fields ...
0
votes
1answer
48 views

What to specify as interfaces in component diagrams

I am following the textbook Object oriented software specification using UML, patterns and Java (3rd edition) and I am defining interfaces between system components (subsystems). But I encountered a ...
0
votes
2answers
119 views

Use case for interface

While going through some lecture video on interface. I noticed If we don't know about implementation, just requirement specification then go for interface. What can be the scenario? Though I've ...
-1
votes
1answer
105 views

Who writes functional specifications and how to track what has been done in a clear and effective manner [closed]

Background: In a project where I work as a developer we did not use a functional specification at first. We relied solely on technical documentation, issues in Jira and mockups/detailed design for ...
3
votes
1answer
60 views

Where should I specify validation messages?

I'm creating a Functional Specification Document (FSD) for a project. I'm pretty confused as to where I should specify error messages? Do they belong in the FSD, or are they part of the Technical ...
2
votes
2answers
84 views

Communicating the intended operation of API business logic to both developers and business people

Currently, I'm designing the intended operation of a (RESTful) API which a team of developers will eventually build. I'm not concerned with implementation details, as long as inputs are correctly ...
0
votes
1answer
39 views

The difference between product scenarios and requirement's Use cases in Software Specifications [closed]

I am trying to write down a specification for a project ( still a starter ) and I got into the nuance between the two sections : product scenarios and the following requirement's Use cases. I didn't ...
0
votes
2answers
88 views

How to link domain specifications with the code implementation without forcing domain expert to adopt any particular practice

Our current business process is that the domain experts will write down the business logic in a Word document, and developers will try to reflect those logic as closely as possible with the ...
1
vote
1answer
35 views

One resource per business object or many resources for many purposes?

I'm developing a JavaScript UI client and my back-end developer refuses to pass me the data in a form that I don't have to transform afterwards. So, I'm currently working on a mapper that contains a ...
3
votes
1answer
93 views

Is Cucumber appropriate for expansive corner case specification?

Question So, is using Cucumber to (near)exhaustively define complex interactions of requirements by example an abuse of the tool? Question Setup Is it appropriate use of Cucumber (or any other ...
-1
votes
1answer
50 views

What techniques can be used to clearly define the scope of a development task or work package?

Most people agree that it is a good thing to split a software development project into many small tasks each of which can be implemented within a few hours. But the finer the granularity, the more ...
0
votes
1answer
263 views

Are Program Managers still being used?

I recently read an an article about Functional Specifications by Joel Spolsky (if his name sounds familiar, its likely because the good Mr. Spolsky is one of the StackExchange founders). In the ...
6
votes
1answer
172 views

How to avoid or amalgamate tiny late-project user stories?

At the beginning of a project, writing things up as user stories is a great way of getting a handle on the functionality of a project. Stories at this stage tend be conceived and written relatively ...
3
votes
0answers
96 views

Webapplication and App: Use case redundancy

I have to write a software requirements specification for a software system that consists of two front-ends, an Android app as well as a web-application. The Android app and the web-application have ...
3
votes
1answer
104 views

How to document logical proofs against race conditions?

Specific Background I'm writing a library to extend the async backbone of a language with cooperative multitasking. (The language is Hack, but C# also implements async-await with Task, if the concept ...
4
votes
3answers
146 views

Requirement Specification - How to write an “as much as possible” requisite

I have a few requirements of the type "the system shall be as modular as possible (to allow distributed installation and reduce cabling)" "to reduce development and maintenance costs, the same ...
3
votes
1answer
103 views

Is it appropriate to use Semantic Versioning for the specification for a key/value file format?

I'm writing a Python tool to convert/store the data from a commonly used plaintext file format for volumetric data generated by computational chemistry calculations into the binary HDF5 format using ...
0
votes
1answer
329 views

How can I create a combined UX and Functional Spec?

Our organization has been clamoring for a more organized spec-making process. At the moment, we use a combination of UX Specs (created in a wireframing tool and published as PDFs), and Functional ...
3
votes
2answers
275 views

How to write System requirements - not all architectures fulfill all requirements

We have a system that is largely configurable, that can be organized in different architectures, and I'm struggling to write its requirement specification. I'll give an example Module 1 does A Module ...
6
votes
3answers
421 views

How important is documentation?

How important is a documentation? or a spec for that matter? I've been writing software professionally now for about 5 years. Each new job I start I am more often than not faced with spending a few ...
7
votes
1answer
1k views

Algorithms for color blending modes: hue, saturation, color, luminosity

I'm working on a JavaScript utility where I'm trying mix two colors in different ways. I basically want to cover the blend modes provided by Photoshop / the W3C spec on compositing and blending (which ...
7
votes
5answers
186 views

Who (client or provider) should write the specifications document

I have the opportunity to work on a project to create a phone app. I have been given a document that's about 60 words total. There are a couple of phone calls and SMS message too, but it's clear to me ...
3
votes
2answers
1k views

Does Scrum need System specification document?

We're building a website to manage our company asset, and apply Agile/Scrum to this project. We started with the Product backlog as in attachment. We planned to start the first Sprint but the team ...
3
votes
3answers
138 views

Should I implement a obfuscated spec literally?

I'm tasked with implementing a spec for a simple simulated shopping system. The spec however uses strange abreviations everywhere (it has a 2 page long table of nonsense abreviations). For example the ...
0
votes
1answer
39 views

Where is the FormData constructor spec? Am I reading this correctly?

Looking at the w3 spec for FormData there seems to be very very little there. Certainly very little compared with the MDN documentation. Of most concern, there is nothing here that defines ...
4
votes
2answers
179 views

How do you adapt to changes to product specifications during development?

Problem Changes to product requirements/specifications during the development cycle are inevitable in a professional setting. In particular, I'm constantly dealing with changes to the specification ...
2
votes
0answers
296 views

Dynamic React Application Components - like Django Admin

First, to those who don't know, Django-admin, a decade old applications works as such: You write a class describing the functionality and the expected behaviour of the application: class AuthorAdmin(...
1
vote
1answer
373 views

What is the meaning of the data inside wave_format_ieee_float?

I made a program that connected to the microphone and captured wave_format_ieee_float data from it. I noticed that if I made a really loud noise the data seems to fluctuate between -1 and 1 (when I ...
1
vote
0answers
48 views

Should the developer help customer to write the user stories? [duplicate]

Recently, two guys contacted me and asked me to build their mobile app. They have a brand new concept and want an app quickly. I told them that I need some user stories and some specifications by ...
4
votes
4answers
877 views

Can we ever fully, completely specify anything? [closed]

This question is more theoretical than practical. Imagine we have an intelligent machine that if is fed with a fully complete specification of an object then that machine will produce exactly that ...
-2
votes
2answers
773 views

Where can I find software project deliverables/ documents to help me professionally document my projects? [closed]

Hie guys. I have never been employed in the software development industry and when I do projects I usually just draw non-standard diagrams or used use case diagrams and class diagrams. This time a ...
4
votes
1answer
831 views

What is the reason that CSS variables are defined using two hyphen characters (--)?

CSS variables supported natively it's a powerful feature to develop complex web apps without some additional step as preprocessors. So, this is fantastic. But (at first) the syntax of defining ...
3
votes
4answers
363 views

Where do Interface descriptions belong in a spec?

At my job we have a fairly elaborate specifications model. Basically we need to create 3 layers of specifications where each subsequent level elaborates on the previous. We've got: the top layer ...
6
votes
2answers
314 views

How to define fixed priced software projects and how to argue what is inside scope and what is outside scope? [closed]

So here is what happened The customer gave me a list of things he wanted to have. It is a funding website. So to start a funding project he wanted to have certain fields in the "create/edit funding ...
3
votes
3answers
4k views

Should I use future or present tense when writing a design spec document?

I'm writing a Design Specification Document for a college project and wondering about the tense I should use. The development on the project has not yet started, I'm just writing the UI design section....
1
vote
2answers
138 views

How imperative is the need of specifications being written down in case of a new project?

I have a new project to deal with. I'm the only one to deal with it currently (a kind of a personal project). It's likely that in the future there will be more contributors to it. Taking in account ...
3
votes
1answer
285 views

How much effort should I put into the functional specification?

I've spent six full days so far working on a spec for a web-app component. Apart from personally wanting some task that doesn't involve Word, I'm wondering if there is a point at which I know that the ...
2
votes
2answers
114 views

Which style to use for features that are not directly driven by humans when using BDD Gherkin language?

Should they be written same way as human workflows, first person "I have entered..." style language etc.? Is the user effectively a gender-less "AI"?
7
votes
3answers
251 views

Can I avoid more faults if I use different paradigms for the implementation and the specification/tests?

Since it is convenient for the developer, the same paradigm are often used for implementations and specifications, e.g. for testing (e.g. Java for the implementation and unit tests, Scala for the ...
2
votes
2answers
146 views

Crypto hash in 'a href'?

It seems to me that it would be pretty useful to be able to indicate an expected crypto hash value in file downloads especially since so many application and data downloads rely on mirrored hosting. ...
-1
votes
1answer
45 views

How to help you client into making better requirements for you? [duplicate]

One of the most difficult and critical part of a project is to get good requirements from your client (internal or otherwise). I understand by 'good requirement' one that is not so high-level that's ...
0
votes
1answer
293 views

What are messages in FHIR?

I am trying to get my head around Fast Healthcare Interoperability Resources (FHIR) specification, but I can't understand what Messages are used for. The exact mechanism of transfer is irrelevant ...
1
vote
1answer
519 views

How can I find what Resources a Java EE container provides?

How can I find what "Resources" a Java EE container provides? Can I discover this programmatically, or is there documentation I should refer to? (Note that the Java EE tutorial is vague on this ...
4
votes
1answer
2k views

How do tools facilitate writing functional specifications?

C2 wiki on functional specifications suggest that this can be facilitated by tools, how? A Functional Specification is a list of demands and constraints intended to describe a product to be ...
1
vote
0answers
80 views

How to deal with requests that don't conform to the existing data structure?

The system I'm working on has a list of assets that belong to different customers of the company. This data is saved on an SQL database. Removing irrelevant data, let's say the table is like this: +-...
3
votes
1answer
2k views

How do I write a REStful API's functional specifications?

I've been looking for answers about writing functional specifications for a software for a while now but I can't seem to find an answer to my specific case. I think I understand the difference ...
3
votes
2answers
216 views

How to deal with historic exception specifications in maintained C++ code

Today, I discovered a few exception specifications in legacy code I've to maintain, when Cppcheck 1.68 ([Inconclusive] but correctly) pointed out that the specified exceptions are not handled in ...
3
votes
2answers
197 views

What is meant by “redundant, but not duplicative” in the Steelman language requirements?

The Steelman language requirements have this: The language shall require some redundant, but not duplicative, specifications in programs. I think I can see the underlying idea (that re-stating ...
4
votes
2answers
995 views

Where is it specified that Java is call by value?

I know that Java is by default call-by-value but I am not sure where in the Java Language Specification this is addressed. Google searching only seems to find me unofficial sources but never points to ...
1
vote
2answers
207 views

The source is the documentation - part 1 [closed]

Searching the specification for the btrfs file system i stumbled once more over the catchphrase: "The code is the documentation". This implies that changing the code changes the specification. Does ...