Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve clarity, formality, and traceability in srs #161

Open
13 tasks
nebrask opened this issue Dec 22, 2024 · 0 comments
Open
13 tasks

chore: improve clarity, formality, and traceability in srs #161

nebrask opened this issue Dec 22, 2024 · 0 comments

Comments

@nebrask
Copy link
Collaborator

nebrask commented Dec 22, 2024

The following feedback from Hunter highlights areas for improvement in our SRS. These changes aim to enhance clarity, formalize certain sections, and ensure traceability:

  1. Glossary and Definitions:

    • Simplify and clarify definitions in the glossary section.
    • Define all terminology and acronyms explicitly (e.g., ReLU, LLM).
    • Provide a references section at the end to properly cite and cross-reference sources, avoiding informal citations like "@".
  2. Grammar, Formatting, and Conciseness:

    • Address minor grammar and formatting issues throughout the document.
    • Ensure the writing is concise and avoids overly "flowery" language, especially in technical sections like "Current Situation."
  3. Notation and Diagrams:

    • Define key notations and terminologies in diagrams and tables (e.g., specify the type of input for an n x m matrix).
    • Use correct mathematical notation and formalize critical sections, potentially leveraging discrete math, finite state machines, or Z notation.
  4. Requirements and Traceability:

    • Illustrate relationships between requirements using diagrams or traceability tables.
    • Revisit Non-Functional Requirements (NFRs) to ensure they are verifiable.
  5. Rationales and Development Plan:

    • Expand on some requirement rationales for better clarity.
    • Include more details on how requirements will be prioritized and implemented in the development plan.
  6. Citations and References:

    • Include a dedicated references section.
    • Improve citations for better accuracy and traceability.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant