Skip to content

Latest commit

 

History

History
100 lines (62 loc) · 4.82 KB

AI-Prompt.md

File metadata and controls

100 lines (62 loc) · 4.82 KB
Raw

AI Documentation Prompts for the HashCode Project

This document outlines a series of AI-generated prompts intended to assist in creating comprehensive documentation for the HashCode competitive programming platform.

Table of Contents

Introduction

  • Prompt: "Write a brief introduction to the HashCode platform, including its purpose and the problem it solves in the competitive programming community."
  • Prompt: "Detail the scope of the HashCode project, outlining what is included and what is excluded."

Design Principles

  • Prompt: "List and explain the core design principles guiding the development of HashCode, such as modularity, reusability, scalability, security, maintainability, and performance optimization."

System Architecture

  • Prompt: "Describe the overall system architecture of HashCode, detailing each component and its role within the platform."
  • Prompt: "Create a high-level diagram illustrating the interactions between the frontend, backend services, database layer, code evaluation engine, and cloud infrastructure."

Detailed Design

Component Design

  • Prompt: "Provide a detailed description of each system component, including the web interface, application server, database, authentication service, contest engine, judge system, and wallet service."
  • Prompt: "Explain how each component interacts with others and contributes to the overall functionality of the platform."

Data Design

  • Prompt: "Outline the database schema, detailing the structure of tables such as Users, Contests, Submissions, and Transactions."
  • Prompt: "Highlight the relationships between different data entities and any indexing strategies used for optimization."

Activity Diagrams

  • Prompt: "Develop activity diagrams for key user interactions, such as user registration and contest participation."
  • Prompt: "Explain each step in the processes depicted in the activity diagrams."

User Requirements

User Personas

  • Prompt: "Define user personas representing the primary and secondary users of HashCode, including their goals, motivations, and how they interact with the platform."
  • Prompt: "Describe specific needs and requirements for each user persona."

Functional Requirements

Contest Management System

  • Prompt: "List the functional requirements for the contest management system, including contest creation, scheduling, and state transitions."
  • Prompt: "Specify how users can participate in contests and how the system handles submissions."

Code Evaluation System

  • Prompt: "Explain the features of the code evaluation system, including how it processes submissions, runs test cases, and provides feedback."
  • Prompt: "Detail the security measures in place to sandbox code execution."

Non-Functional Requirements

Performance Requirements

  • Prompt: "Describe the performance requirements of the platform, such as response times, throughput, and concurrency handling."
  • Prompt: "Outline strategies for performance optimization, including caching mechanisms and load balancing."

Security Requirements

  • Prompt: "Identify the security requirements, including authentication protocols, data protection measures, and compliance with relevant standards."
  • Prompt: "Explain how the platform ensures the integrity and confidentiality of user data."

Testing Plan

  • Prompt: "Develop a comprehensive testing plan covering unit tests, integration tests, system tests, and user acceptance tests."
  • Prompt: "Specify the criteria for pass/fail outcomes and how defects will be recorded and addressed."

Others

  • Prompt: "Improve the documentation language by making it look more professional and easy to read"
  • Prompt: "Make the documentation more visually appealing and standard so that it looks production grade document"
  • Prompt: "Expain the key terms of SRS files in more detailed manner and remove uncessary details from the entire document"

References

  • Prompt: "Include a list of references used in developing the HashCode platform, such as industry standards, guidelines, and external documentation."
  • Prompt: "Provide links to resources like the Software Engineering Body of Knowledge (SWEBOK) and any relevant templates or standards."

Note: These prompts are designed to guide the documentation process, ensuring that all critical aspects of the HashCode project are thoroughly covered.