.net - How should I document an existing system -

-

I started with a sole responsibility for a large job (ISH) financial application. It has approximately 800 stored procedures, 120 SQL server tables and 18 net projects about 1200 code files. And no document except in line comments in the code.

As I am improving the bug and adapting to the data, I want to document the document I am looking for.

The main thing I'm interested in is what happens after the user does (for example, presses a button to upload) how the data changes and how to make that change. The methods / procedures are called in such a way that if a bug is seen by users later, then I can quickly see the path taken through the codes / tables, what should I use this document? Is this a UML use case or sequence diagram? Or something else?

Any ideas are welcome Richard

"Let me record it What is the use of a UML for a case or sequence diagram? "

Both.

User experience is a use case. Let's character and text to describe the user's interaction. You can use state charts or sequence diagrams to provide details, but usually it is a waste of time. Words will be for this.

The implementation sequence diagram may be. Often, this is not enough You probably need some class diagram to describe the data model. Actually, you often need two level class diagrams - a conceptual level and a logical level.

You also want a component diagram showing all the pieces and parts and where everything fits together.

Finally, you want to see (logical, process, component, deployment and use case) as a way to separate the document, so this is not a random heap of notes.


Comments

Post a Comment

Popular posts from this blog

c# - ListView onScroll event -

-
I am programming a simple C # application, and I need a Scallow event on the list view. So I inherited the original ListView class created in ListviewEx witch. I found out how to locate the scroll message from WinAPI and I modified the WndProc method. Now I have this WndProc: protected override zero WndProc (Ref message message) {base.WndProc (Ref I); If (m.msg == WM_VSCROLL) {onScroll (This, New EventArgs ()); }} But the problem is, I do not know how to know about scrolling information. This data should be in wParam, but there is a LOWORD macro ++ like in C in C # and I switch to find the criteria like SB_ below, SB_ENDSCROLL, SB_PAGEUP etc. there any way Need to change the LOWORD macro from C #? Or any other way to find the necessary parameters about scrolling? You can define the WParam constants as the following: Private const int WM_HSCROLL = 0x114; Private Constant WM_VSCROLL = 0x115; Private contact int SBHOZZ = 0; Private Consultant SB_VERT = 1; Private Con...
Read more

PHP - get image from byte array -

-
I am trying to create a back-end for my mobile application. I am sending the content of an image in the body of the HTTP request (output stream) as a byte array, I want to read this stream of bytes in PHP scripts and take back an image. Can anyone tell me how can I do this? Thank you. You can obtain the request body $ body = Reading from file_get_contents ('php: // input'); What you do with that data Depending on you, you can write the data in a file as you mentioned that this is image data, you can drop the data into the object can do. Another option is to use and load the image.
Read more

Linux Terminal Problem with Non-Canonical Terminal I/O app -

-
I have a small app written in C to run on Linux. Part of the app accepts user-input from keyboard , And it uses non-canonical terminal mode so that it can respond to each keystroke. The section of the code that accepts input is a simple task that is called repeatedly in the loop: char get_input () {char C = 0; Int res = reading (input_tamille, & amp; c, 1); If (RSS == 0) 0 returns; If (res == -1) {/ * snip error handling * /} return c; } It reads a letter from the terminal if there is no input within a given time limit, (c_cc [VTIME] value in the vocabulary structure), read () 0 And get_input () is called again It all works very well, I have recently discovered that if you run this app in a terminal window, and then the app Close the terminal window without ending, the app will not exit Received, but CPU intensive launches into an infinite loop, where the read () returns 0 without waiting continued. So how can I get out of the apple if it runs from the terminal win...
Read more