DEV Community

Boris Shulyak
Boris Shulyak

Posted on

High Level requirements and purposes

#webdev #beginners #programming #documentation

On this page I have provided the basic tamplate for creating the first document of you startup idea.

WARNING: Only the title and general structure is important in the template. Other text in the code blocks was provided just an example.

Name and Domain Area 

Software name and description of the domain area and end users.
Enter fullscreen mode Exit fullscreen mode

Basis for Development 

1. What is the basis for the development of `<software-name>`?
2. What is the purpose of development?
3. What is the functional and operational purpose of the program or software product?
Enter fullscreen mode Exit fullscreen mode

Requirements for Software

Requirements for Functional Characteristics

The software should provide the execution of the following main functions:

User Interface:

- Function 1;
- Function 2, and so on.

Include the UI mockups here.
Enter fullscreen mode Exit fullscreen mode

For the User:

- Function 1;
- Function 2, and so on.
Enter fullscreen mode Exit fullscreen mode

For the system administrator (if applicable):

- Function 1;
- Function 2, and so on.
Enter fullscreen mode Exit fullscreen mode

Additional Requirements:

- Function 1;
- Function 2, and so on.
Enter fullscreen mode Exit fullscreen mode

Reliability Requirements 

Provide input information control and protection against incorrect user actions. Ensure the integrity of information in the database
(if the software includes a database).
Enter fullscreen mode Exit fullscreen mode

Type of Service needed for your Software 

Specify the type of service required for development. Specify that "Service type requirements are not specified" if the development does not require
special servicing.
Enter fullscreen mode Exit fullscreen mode

Servicing Staff 

If necessary, specify the main servicing operations, the required number, and qualification of personnel. 
Specify that "Requirements for servicing personnel are not specified" if the development does not require servicing personnel.
Enter fullscreen mode Exit fullscreen mode

Requirements for the hardware technical characteristic needed for you software 

Specify the type, composition, and characteristics of hardware.

Minimum tech configuration:
- Processor type: Intel Core i5;
- RAM capacity: 4 GB;
- Internet connection with a speed of at least 20 megabits;
- ...

Recommended techn configuration (and on which the development was carried out):
- Processor type: Intel Core i7;
- RAM capacity: 8 GB;
- Internet connection with a speed of at least 100 megabits;
- ...
Enter fullscreen mode Exit fullscreen mode

Requirements for Informational and Software Compatibility 

The software should operate under the management of operating systems from the WIN32 family (Windows'XP, Windows NT, etc.) or Unix.
Enter fullscreen mode Exit fullscreen mode

Requirements for Tech Stack 

- Development should be done in the programming language...
Enter fullscreen mode Exit fullscreen mode

Requirements for Development Environment 

Development should be carried out on the platform (using the environment)...
Enter fullscreen mode Exit fullscreen mode

Requirements for Versioning and Packaging 

- npm registry: ...
- Keep the sematic versioning
Enter fullscreen mode Exit fullscreen mode

Requirements for Transportation and Storage 

No requirements for transportation and storage are specified.
Enter fullscreen mode Exit fullscreen mode

Special Requirements 

No special requirements.
Enter fullscreen mode Exit fullscreen mode

Read More

Top comments (0)

Read next

servbay profile image

Laravel 11 with Servbay: Quick Start Guide

ServBay -

wangliwen profile image

The Importance of JavaScript Obfuscation: Safeguarding Your Code Integrity

WangLiwen -

sammaji15 profile image

How to show progress while downloading data in node.js

Samyabrata Maji -

shilleh profile image

How to Connect MPU9250 and Raspberry Pi (Part 2 - Calibration)

Shilleh -