Questions tagged [specifications]
A specification (often abbreviated as spec) is an explicit set of requirements to be satisfied by a material, product, or service.
161
questions
3
votes
2
answers
294
views
what is the difference between system requirements and software requirements?
For my project, I am required to complete a software requirement and systems requirement for a program I am developing which needs to be fairly detailed. However I am struggling to differentiate ...
- 41
-4
votes
2
answers
58
views
What are some workflows that one engineer may use to implement a software specification?
I've never implemented an entire specification before and wanted to know what a workflow may look like to do so. I have worked on code that was backed by such a specification, but only in maintenance ...
- 1,124
0
votes
0
answers
47
views
Share models between AsyncAPI and RESTful APIs?
What I try to solve:
Given I run a set of microservices, most of which expose a RESTful API and additionally publish or consume events via messaging broker,
and I have decided to go "API first&...
- 107
1
vote
1
answer
56
views
Writing specification: can business rules apply to a specific vendor or third party service implementation?
I am writing a simple specification for a module that is part of a bigger call center application. First I write down business rules, then application logic. I realize that some rules apply only to a ...
- 396
2
votes
1
answer
28
views
How to create description of internal component behaviour?
I am looking for a way to technically describe the behavior of the internal components of the implemented system. I need to be able to describe all the components and the behavior between them:
...
- 289
-4
votes
2
answers
110
views
What is the most complete way to test an imperative function?
What is the most complete way to test an imperative function? By "complete" I mean, something that is robust, that tests all the edge cases of the function, that so much as "proves"...
- 2,406
3
votes
4
answers
660
views
If logging in is not a Use Case, then what is it and where do I describe it?
I am writing a functional specification for a project and I wish to express the expected system behaviour in Use Cases.
I have read a bunch of opposing opinions on whether "logging in" ...
- 357
1
vote
0
answers
44
views
Specifications Pattern crossing bounded context - Domain Driven Design
I'm trying to understand and implement with good practice the Specification Pattern within my domain driven design project.
I have few questions:
For example: verifying that a customer is subscribed ...
- 11
-2
votes
6
answers
204
views
Why don't packages formally specify (and repositories verify) their contracts
So, most software depends upon third-party libraries, to some extent or another. Specifications of such libraries' behaviour usually takes the form of human-readable documentation.
We write ...
- 15
-2
votes
1
answer
67
views
Designating a pin header and a GPIO
I have an Acconeer XB112 breakout board and an XM112 radar module. It all works just fine per the Acconeer documentation and tutorials.
Now I want to modify some of the code to output to a GPIO. ...
- 107
-2
votes
1
answer
2k
views
UML use case and activity diagrams in SRS document
I'm writing a Software Requirements Specification (SRS) document compliant with the standard IEEE-830-1998. I've also drawn a couple of UML diagrams, specifically a use case and an activity diagram.
...
- 103
5
votes
2
answers
260
views
In an UML 2.5 State Machine, how can I model sending a Signal as an effect on a transition in a convenient way?
In an UML 2.5 State Machine, how can I model sending a Signal as an effect on a transition in a convenient way?
In one of the older UML versions you simply prefixed the name of the signal with a send ...
- 159
3
votes
4
answers
224
views
Should operating system configuration parameters, like disabled automatic updates or sleep timer, be part of the software specifications?
Our application needs to run in a locked-down operating system. Due to quality and regulatory concerns, all updates shall be prevented or blocked. Therefore, our deployment includes the pre-configured ...
- 39
1
vote
1
answer
252
views
What is the BNF (or BNF-like) syntax for a specific number of repetitions?
I would like to write something like
<byte> ::= <bit>*8
to mean that a <byte> is a sequence of exactly 8 <bit>'s.
Is there a way to do this in BNF[1][2] or a widely used ...
- 121
6
votes
1
answer
210
views
How can I clearly present specifications for user permission levels?
I need to write specifications for permissions levels on a system. There are two types of user (Viewer and Editor). Everything a Viewer can do, an Editor can also do. An Editor’s permissions build on ...
- 202
3
votes
4
answers
806
views
In TDD, should we specifiy all classes to implement before start coding
My team is interested to apply TDD in our next software project. We have a discussion about how many details should be specified in design specs before the developers start coding.
Some of us propose ...
- 193
-1
votes
1
answer
1k
views
How to handle interface change between back-end and front-end during development
Introduction
In our development team, we divide developers into back-end and front-end teams. To develop a feature for a website, the 2 teams have to work in parallel. We starts by analyzing the ...
- 193
2
votes
3
answers
234
views
How to specify that a number is a random number, or a rounded number, etc
Trying to better understand how to write specifications for automated theorem proving and testing, etc. One seemingly simple example is generating a random number. I would like to know how to specify ...
- 2,406
-1
votes
1
answer
66
views
What is the benefit of the specification approach in JavaEE?
What is the benefit of having multiple implementations just for doing one thing? Are there any other languages that use this concept?
- 27
2
votes
1
answer
299
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 ...
- 137
0
votes
1
answer
267
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
2
answers
1k
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 ...
- 119
0
votes
1
answer
3k
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 ...
- 119
5
votes
1
answer
283
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
2
answers
263
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 ...
- 325
0
votes
1
answer
180
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 ...
1
vote
2
answers
125
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
1
answer
44
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 ...
- 477
5
votes
1
answer
197
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,838
-1
votes
1
answer
208
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 ...
- 6,361
1
vote
1
answer
307
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
1
answer
187
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,526
2
votes
2
answers
190
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 ...
- 29
3
votes
1
answer
115
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 ...
- 497
5
votes
3
answers
218
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 ...
- 81
2
votes
1
answer
402
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 ...
- 131
0
votes
1
answer
499
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 ...
- 9
2
votes
2
answers
488
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 ...
- 81
6
votes
3
answers
910
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 ...
- 179
7
votes
1
answer
3k
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 ...
- 231
7
votes
5
answers
278
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 ...
- 331
2
votes
2
answers
4k
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 ...
- 21
3
votes
3
answers
146
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 ...
- 870
0
votes
1
answer
53
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 ...
- 2,002
4
votes
2
answers
633
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 ...
- 67
3
votes
1
answer
918
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 ...
- 133
1
vote
0
answers
57
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 ...
- 3,758
4
votes
4
answers
891
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 ...
- 149
-1
votes
2
answers
1k
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 ...
- 109
8
votes
1
answer
4k
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 ...
