Documentation

Design Documentation

Table of Contents

• Design Documentation
• FAQ
  • Should I use future or present tense when writing a design spec document?
  • What should be appropriate Modal Verbs to define the requirement?
• References

FAQ

Should I use future or present tense when writing a design spec document?

• https://developers.google.com/style/tense
• https://softwareengineering.stackexchange.com/questions/301754/should-i-use-future-or-present-tense-when-writing-a-design-spec-document

What should be appropriate Modal Verbs to define the requirement?

• RFC2119 - Key words for use in RFCs to Indicate Requirement Levels
• https://softwareengineering.stackexchange.com/questions/185868/best-practices-for-usage-of-shall-and-must-when-writing-requirements

References

1. https://medium.com/machine-words/writing-technical-design-docs-71f446e42f2e
2. https://www.freecodecamp.org/news/how-to-write-a-good-software-design-document-66fcf019569c/