Samer Abu Zaina
  • NEW!
    NEW!  Connect Ideas Across Notes
    Save time and share insights. With Paragraph Citation, you can quote others’ work with source info built in. If someone cites your note, you’ll see a card showing where it’s used—bringing notes closer together.
    Got it
      • Create new note
      • Create a note from template
        • Sharing URL Link copied
        • /edit
        • View mode
          • Edit mode
          • View mode
          • Book mode
          • Slide mode
          Edit mode View mode Book mode Slide mode
        • Customize slides
        • Note Permission
        • Read
          • Only me
          • Signed-in users
          • Everyone
          Only me Signed-in users Everyone
        • Write
          • Only me
          • Signed-in users
          • Everyone
          Only me Signed-in users Everyone
        • Engagement control Commenting, Suggest edit, Emoji Reply
      • Invite by email
        Invitee

        This note has no invitees

      • Publish Note

        Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

        Your note will be visible on your profile and discoverable by anyone.
        Your note is now live.
        This note is visible on your profile and discoverable online.
        Everyone on the web can find and read all notes of this public team.

        Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

        Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

        Explore these features while you wait
        Complete general settings
        Bookmark and like published notes
        Write a few more notes
        Complete general settings
        Write a few more notes
        See published notes
        Unpublish note
        Please check the box to agree to the Community Guidelines.
        View profile
      • Commenting
        Permission
        Disabled Forbidden Owners Signed-in users Everyone
      • Enable
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Suggest edit
        Permission
        Disabled Forbidden Owners Signed-in users Everyone
      • Enable
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
      • Emoji Reply
      • Enable
      • Versions and GitHub Sync
      • Note settings
      • Note Insights New
      • Engagement control
      • Make a copy
      • Transfer ownership
      • Delete this note
      • Save as template
      • Insert from template
      • Import from
        • Dropbox
        • Google Drive
        • Gist
        • Clipboard
      • Export to
        • Dropbox
        • Google Drive
        • Gist
      • Download
        • Markdown
        • HTML
        • Raw HTML
    Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Engagement control Make a copy Transfer ownership Delete this note
    Import from
    Dropbox Google Drive Gist Clipboard
    Export to
    Dropbox Google Drive Gist
    Download
    Markdown HTML Raw HTML
    Back
    Sharing URL Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Customize slides
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.

    Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Explore these features while you wait
    Complete general settings
    Bookmark and like published notes
    Write a few more notes
    Complete general settings
    Write a few more notes
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    1
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # How to Write a Professional Software Requirements Specification (SRS) ![SRS](https://hackmd.io/_uploads/S135I-jiZl.png) Writing a **professional Software Requirements Specification (SRS)** is not only about the content—it is also about **structure, formatting, clarity, and professionalism**. This guide explains the process **step-by-step**, from document setup to final review. The approach follows common industry standards such as: - IEEE 830 Software Requirements Specification Standard - ISO/IEC/IEEE 29148 Requirements Engineering Standard --- # 1️⃣ Choose the Right Tool and File Setup Most professional SRS documents are written using: - Microsoft Word - Google Docs - LaTeX (very professional for academic reports) For most students and development teams, **Microsoft Word or Google Docs is sufficient**. ## Recommended File Settings **Font Sizes** - Title → 18–20 pt - Headings → 14–16 pt - Text → 11–12 pt **Font Types** - Times New Roman (formal and academic) - Calibri (modern professional) **Document Layout** - Line spacing → 1.15 or 1.5 - Alignment → Justified - Margins → 2.5 cm on all sides --- # 2️⃣ Professional Color Usage Professional SRS documents **avoid using many colors**. Use **two colors at most**. | Element | Recommended Color | |-------|----------------| | Main text | Black | | Headings | Dark blue or black | ### Example Style - Title → Dark Blue - Headings → Bold Black - Text → Black ### Avoid - Bright colors - Colored paragraphs - Background highlights Professional documents should remain **clean and minimal**. --- # 3️⃣ Symbols and Icons (Are They Professional?) Symbols can be used **in moderation**. ## Acceptable - Tables - Numbered lists - Bullet points - Diagrams - UML diagrams ## Avoid - Emojis - Decorative icons - Too many symbols ### Professional Example ``` System Features: • User registration • Login authentication • Course enrollment ``` ### Not Professional ``` ✨ User registration 🔥 Login authentication 🚀 Course enrollment ``` --- # 4️⃣ Standard Structure of an SRS Most SRS documents follow the structure recommended by the **IEEE 830 standard**. --- # 1. Title Page The title page should include: - Project name - Document title - Author name - Version - Date Example: ``` Vehicle Rental Application Software Requirements Specification (SRS) Author: Samer Alaa Abu Zaina Version: 1.0 Date: March 2026 ``` --- # 2. Table of Contents The table of contents should be **automatically generated**. Example structure: ``` 1. Introduction 2. Overall Description 3. System Features 4. External Interface Requirements 5. Non-Functional Requirements 6. System Models 7. Appendices ``` --- # 5️⃣ Section 1 — Introduction Write **short and clear paragraphs**. ## 1.1 Purpose Explain **why the document exists**. Example: > This document describes the functional and non-functional requirements of the Vehicle Rental Application. > It is intended for developers, project managers, and stakeholders. --- ## 1.2 Scope Explain **what the system does**. Example: > The Vehicle Rental Application allows users to search for vehicles, reserve them, and manage rental transactions through a mobile application. --- ## 1.3 Definitions Explain technical terms. | Term | Definition | |-----|------------| | API | Application Programming Interface | | User | Person who rents a vehicle | --- # 6️⃣ Section 2 — Overall Description ## 2.1 Product Perspective Explain how the system fits into the larger environment. Example: > The system is a mobile application developed using Flutter and connected to a backend server via REST APIs. --- ## 2.2 User Classes Describe the different system users. | User Type | Description | |----------|-------------| | Customer | Person who rents vehicles | | Admin | Manages vehicles and users | --- ## 2.3 Operating Environment Example: - Android devices - iOS devices - Internet connection - Cloud database --- # 7️⃣ Section 3 — System Features This is **one of the most important sections**. Each feature should include: - Description - Inputs - Process - Outputs Example: ## 3.1 Vehicle Search **Description** Users can search for vehicles based on location, type, and price. **Inputs** - Location - Vehicle type **Output** - List of available vehicles --- # 8️⃣ Section 4 — External Interface Requirements ## User Interface Explain the application screens. Example: - Login Screen - Vehicle Search Screen - Booking Screen You may also include **UI mockups**. --- ## API Interfaces Example: | API | Method | Description | |----|------|-------------| | /login | POST | User authentication | | /vehicles | GET | Retrieve vehicle list | --- # 9️⃣ Section 5 — Non-Functional Requirements These requirements define the **quality attributes** of the system. ## Performance The system should respond within **2 seconds**. ## Security User passwords must be **encrypted**. ## Usability The application must be **easy to use**. ## Reliability System uptime must be **99% or higher**. --- # 🔟 Section 6 — Diagrams (Highly Recommended) Include diagrams such as: - Use Case Diagram - Sequence Diagram - Database ER Diagram - System Architecture Diagram Common tools used for diagrams: - Draw.io - Lucidchart - Microsoft Visio --- # 11️⃣ Paragraph Writing Style Use: ✔ Short paragraphs ✔ Simple sentences ✔ Active voice ### Good Example > The system allows users to reserve vehicles online. ### Poor Example > The process of vehicle reservation will be performed by the system through a mechanism that allows the user to select a vehicle. --- # 12️⃣ Professional Numbering Always use **hierarchical numbering**. Example: ``` 1 Introduction 1.1 Purpose 1.2 Scope 2 Overall Description 2.1 Product Perspective 2.2 User Classes ``` --- # 13️⃣ Use Tables Instead of Long Text Professional SRS documents prefer **tables for requirements**. Example: | Requirement ID | Description | |---------------|-------------| | FR-1 | User can register | | FR-2 | User can login | | FR-3 | User can rent vehicle | --- # 14️⃣ Version Control Maintain a version history. | Version | Date | Author | Description | |-------|------|------|-------------| | 1.0 | Mar 2026 | Samer | Initial version | --- # 15️⃣ Final Checklist Before Submitting Before submitting your SRS, verify that: - No grammar mistakes exist - Formatting is consistent - Headings are clear - Requirements are numbered - Diagrams are included - Table of contents works properly --- # 16️⃣ Professional Tips ## Tip 1 — Requirements Must Be - Clear - Measurable - Testable ### Bad Example > The system should be fast. ### Good Example > The system should respond within **2 seconds**. --- ## Tip 2 — Each Requirement Should Be Atomic Each requirement should represent **one idea only**. ### Bad User can login and update profile. ### Good FR-1: User can login FR-2: User can update profile --- # Author **Samer Alaa Abu Zaina** Computer Engineering | Flutter Developer GitHub https://github.com/SamerZaina

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password
    or
    Sign in via Google Sign in via Facebook Sign in via X(Twitter) Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    By signing in, you agree to our terms of service.

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully