The design document is a key piece of a project and used throughout the lifecycle of the product. The following is a sample template for a software design document: Introduction – A paragraph about project/product Objective – A paragraph on the problem being solved Requirements – Specifications, expectations High-Level Design – How the new product/feature fits/interacts with existing systems Low-Level…
Tag: documentation
Rapid Learn Swagger OpenAPI
What is Swagger? A standard way to document REST APIs The documentation is described in a YAML or JSON document. OpenAPI has syntax and tags to write an API description. Why Use Swagger? Very standard It not just describes APIs but also serves as an APIs contract among teams. Each API specifies the expected request, response and response codes. Along…
