SECTION 05 / 14

Development: write code that fits together

1 min read
On this page 1 headings

Developers write code based on the requirements and the design. Development is usually distributed — multiple developers work in different locations and even time zones. Tools like GitHub are used to collaborate. Everyone needs a consistent understanding of the code, which is why developers write documentation and precise interface definitions.

Developers collaborate through code, documentation and shared tools.
Developers collaborate through code, documentation and shared tools.
Open image ↗
Developers collaborate through code, documentation and shared tools.

Why are documentation and interfaces important?

Documentation explains what a part of the code does.

An interface describes the actions your functions can do without describing the implementation in detail — what requests are accepted and in what format the response (output) is given. The code behind the interface can change as long as the interface remains the same. Simply: it is the language two components use to talk — what form a query should take and what form the answer will take.

Shopping Cart sends a request; Payment Service returns a result through an interface.
Shopping Cart sends a request; Payment Service returns a result through an interface.
Open image ↗
Shopping Cart sends a request; Payment Service returns a result through an interface.

EXAMPLE The payment service can change its internal implementation, but if the agreed interface stays the same, the cart can still use it. A changed interface may require other modules to change too.

REMEMBER Team coding succeeds when developers share a clear design and precise interfaces.

YOUR STUDY PROGRESS

Finished this section? Save your progress.

Back to top ↑