URS, FS and DS Documents layout in Software Development

 

  1. User Requirement Specification (URS):

    • Objective: Create an SPFx extension for news notifications on the home page.
    • Scope:
      • Display two types of news: “My News” (from an SQL table) and “Corporate News” (from a different site collection’s Site Pages library).
      • Implement read/unread functionality (gray for read, yellow for unread).
      • Mention the SharePoint list library names where you’ll store data (e.g., “My News” and “Corporate News”).
    • Technical Specifications:
      • Use SPFx framework, React, and REST API for SharePoint data retrieval.
      • Integrate with SQL data using a console application.
      • Specify the SharePoint lists and SQL tables you’ll interact with.
    • Commercial Terms: N/A (since it’s an internal project).
  2. Functional Specification (FS):

    • Design and Construction:
      • SPFx web part layout: Top right corner of the home page.
      • UI design: Display news items with read/unread indicators.
    • Functional Requirements:
      • Fetch data from SQL table and SharePoint list.
      • Implement read/unread logic.
      • Handle display of “My News” and “Corporate News.”
      • Mention any React hooks you plan to utilize (e.g., useStateuseEffect).
      • Describe the key functions or methods your SPFx web part will use (e.g., data retrieval, rendering news items).
    • Non-Functional Requirements:
      • Performance: Fast loading and responsiveness.
      • Usability: Intuitive user experience.
  3. Design Specification:

    • User Interface Design:
      • Layout: Top right corner.
      • Styling: Read/unread indicators (gray/yellow).
    • Data Design:
      • SQL data retrieval: Console application.
      • SharePoint list storage: REST API.
      • Detail the connection to SQL (server name, credentials).
    • System Architecture:
      • SPFx framework, React components.
      • Include React component names and their roles (if applicable).
      • Specify how React hooks fit into your architecture (e.g., managing state, handling side effects).
      • Describe how SPFx web part communicates with SharePoint lists and SQL tables.
      • Data flow: SQL → SPFx web part.
    • Dependencies:
      • SharePoint environment, SQL database.
    • Assumptions and Constraints:
      • SharePoint permissions granted.
      • SQL connection details available.
    • Risks and Mitigation:
      • Data synchronization issues.
      • Performance bottlenecks.

Comments

Popular posts from this blog

Power Apps June 2023 Updates (Canvas App Focused)

Effortlessly Import JSON Data into SharePoint with Power Automate Flow: A Step-by-Step Guide

Unleash the Power of Power Apps: Retrieve Over 2000 Records from a SharePoint List Effortlessly Without Delegates