Suitable TK, very short
Often, on duty, including having to write all sorts of technical requirements, as well as delve into and (command) create documentation on products and solutions. TK - for customer relations, documentation - for developers. The basic principles that should be, briefly, under the cut.
So let's say how your super-duper cms works? How to explain? “Nuuu, we have a bunch of classes here, a template engine, logic, all sorts of interesting chips and finally it’s super-duper, because on xml (phptemplate, HTML :: Template)” - you often hear from the developers. It is, of course, good, guys, but nifiga is not clear.
Explain better what happens between the way I enter the address in the browser line, or enter into the form on the page, and what I see on the screen.
This seemingly simple question sometimes confuses even the main developers of the architecture of an application. But, as a result, a good picture is obtained, of the type “here we bootstrap, parses the get parameter line, calls the modules according to this rule, collects those templates, uploads the data to them and displays the HTML. such a module is responsible for the output of this part of the page, another for the other, etc. "We draw a picture, a flowchart, as it is convenient for everyone, and everything is clear to everyone, even the developers themselves become clearer.
From the client side the same thing: I click this button, and where should I go? And what's next? Yeah, this is understandable, unlike the description “we need a modern super-modern-system in pastel colors and with the functionality that meets the needs of the managers as much as possible. for $ 500, no more. "
In general, it is described
1. What will be at the input and what will be at the output
This is the basis of all TK. Clarification of the needs of the client, for himself and for him. Argument in case of disagreement at the end of development. It is done before the project. If this part is not described, or it is impossible to do, then politics and confusion are involved. To undertake such a project is more expensive. You will go negative or even fail.
2. How input and output are related
Algorithms for system behavior. The second part is important for developers, in fact - the documentation for the project, any. Often, not required, but when transferring code to another developer (if more than one person is working), you NEED to describe. Otherwise, have hemorrhoids with disassembly of the code and its quality, often. It is usually done at the end of the project.
The description may be in free form, in the general case. Often this is obtained in the form of a diagram with footnotes (for algorithms), or in the form of example screenshots (in the case of a site). Well, if this is an official document, then all this is described in detail in words.
Here so briefly it is possible to describe minimally TK and documentation. In general - enough in 90% of cases.
UPD : They ask, why is all this written?
Yes, there are complex and large projects in the field of development, for which huge books have been written on the compilation of TK and documentation, and there it may be necessary. Documentation in thousands of sheets, TK in hundreds of pages.
But there is still a huge mass of not-so-large projects, especially in the web development environment, where there is no sense in writing this large and complex TK and documentation. But even without it, it’s also bad, the minuses are known and indicated. This note is your own experience, the minimum that is necessary to, on the one hand, protect yourself and the client from risks and clarify the situation, write something that another developer can support, on the other hand, spend a reasonable amount of time and effort on this .
Heh, interesting bullshit on this site with karma. at the post at the moment 47 were added to favorites, 11 + and 12 -, total "karma" -1, I can not vote and write comments.
And who these -12 is not clear at all - no comments. Great anonymous? In general, with such a thing, it seems, not to write me anything else on this website - the system does not. And it would be possible to continue.
So let's say how your super-duper cms works? How to explain? “Nuuu, we have a bunch of classes here, a template engine, logic, all sorts of interesting chips and finally it’s super-duper, because on xml (phptemplate, HTML :: Template)” - you often hear from the developers. It is, of course, good, guys, but nifiga is not clear.
Explain better what happens between the way I enter the address in the browser line, or enter into the form on the page, and what I see on the screen.
This seemingly simple question sometimes confuses even the main developers of the architecture of an application. But, as a result, a good picture is obtained, of the type “here we bootstrap, parses the get parameter line, calls the modules according to this rule, collects those templates, uploads the data to them and displays the HTML. such a module is responsible for the output of this part of the page, another for the other, etc. "We draw a picture, a flowchart, as it is convenient for everyone, and everything is clear to everyone, even the developers themselves become clearer.
From the client side the same thing: I click this button, and where should I go? And what's next? Yeah, this is understandable, unlike the description “we need a modern super-modern-system in pastel colors and with the functionality that meets the needs of the managers as much as possible. for $ 500, no more. "
In general, it is described
1. What will be at the input and what will be at the output
This is the basis of all TK. Clarification of the needs of the client, for himself and for him. Argument in case of disagreement at the end of development. It is done before the project. If this part is not described, or it is impossible to do, then politics and confusion are involved. To undertake such a project is more expensive. You will go negative or even fail.
2. How input and output are related
Algorithms for system behavior. The second part is important for developers, in fact - the documentation for the project, any. Often, not required, but when transferring code to another developer (if more than one person is working), you NEED to describe. Otherwise, have hemorrhoids with disassembly of the code and its quality, often. It is usually done at the end of the project.
The description may be in free form, in the general case. Often this is obtained in the form of a diagram with footnotes (for algorithms), or in the form of example screenshots (in the case of a site). Well, if this is an official document, then all this is described in detail in words.
Here so briefly it is possible to describe minimally TK and documentation. In general - enough in 90% of cases.
UPD : They ask, why is all this written?
Yes, there are complex and large projects in the field of development, for which huge books have been written on the compilation of TK and documentation, and there it may be necessary. Documentation in thousands of sheets, TK in hundreds of pages.
But there is still a huge mass of not-so-large projects, especially in the web development environment, where there is no sense in writing this large and complex TK and documentation. But even without it, it’s also bad, the minuses are known and indicated. This note is your own experience, the minimum that is necessary to, on the one hand, protect yourself and the client from risks and clarify the situation, write something that another developer can support, on the other hand, spend a reasonable amount of time and effort on this .
Heh, interesting bullshit on this site with karma. at the post at the moment 47 were added to favorites, 11 + and 12 -, total "karma" -1, I can not vote and write comments.
And who these -12 is not clear at all - no comments. Great anonymous? In general, with such a thing, it seems, not to write me anything else on this website - the system does not. And it would be possible to continue.