All geek questions in one place

Guidance for writing specifications

I was asked (in the place where I just started working) to create simple specifications for some new features that would be added to the existing registration system. I need a little help as I have never done this before. Here are two charts showing the current workflow and the new workflow.

I know that they can be a little vague, but here, what mostly happens. We are adding a new import form to an existing Windows application. We modify the existing form by adding a search button that will search for and fill in the data read by ocr.

I am a new developer and I am not good at writing documents in general, but I would like to improve this. Maybe some examples of how to do this will be helpful. I searched for some examples, but most of them I found to create a completely new system. I need something that shows how to write one to modify an existing system.

Here is my attempt at specification. Maybe someone can criticize this. At least then I will know what I need to improve. http://cid-ddb3f6a92ec2b97e.skydrive.live.com/self.aspx/.Public/Specs.docx

thanks

+3
source share
4 answers

I like to write specifications (I rarely meet in my company).

Charts are a good way, but for a more literal thinker, I start with a full specification template that has a ton of headers. For a new system, you usually have to say something to everyone. In your case, you specifically mentioned the existing application that you are editing, but it is not a matter of filling out all the headers - you need to think about them and then delete them after due consideration. For example:

  • ( , , ).
  • ( )
    • - ..
    • (, , ..)
    • ( , -, )

, , :  -  -  -

, , , . , - . , . , . , - , , .. - . , , , , , .

EDIT:

, . - , , . , , , . , , , .

  • , - (, ), Objective , , . , , , .
  • . , , - , , .
  • : , , . , " ", "", "" .., , . , , "123 Fake St" .. .
  • , , - . - , ? , - ? ? - , , , , - , , . , , .
    • , , , , , , . , .
  • , ? ? , , ? - , Address Street Varchar (30) - , ? , , , , .
  • , , - , ?
  • , , , . , , , , , . , Balsamiq Mockups ( . ) , " " , , . , . (: Balsamiq , /. , PNG .., - , , .)
  • : "", "", "", , . "", .
  • : varchars , unicode (.. nvarchar)?
  • , / Voter, - , ", ". , "ImpRecord001" "ImpRecord002" - , ?
  • " " " OCR"?
+5

: , - , ? ?

, , . , , , , . , , , -, , , , , , "" , .

, . , , ? , , , .

, . "spec"? , , , ", , ". - - . , .

1). doc. , , - . , . , . , , , . , . Powerpoint Word .

2). . , . , , .. , UML . - , ( -) . [ -, , , -:-)]

3). , , 1 2. . , , , . , . . UML, . , , .

, , udner , . , , , ... - , , , , .

+3

.

, , , Windows .

, .

, , , .

, , / , .

Finally, you should sit down at the developer and tell them about the process, going through each step, as I am sure that further details will be needed.

+1
source

Some of the steps down below are a bit verbose. Try to separate them and make sure that the word IF never appears. IF should be assigned with diamond and split the flow paths based on the conditional.

+1
source

Source: https://habr.com/ru/post/1714661/

More articles:


All Articles