diff --git a/README.md b/README.md index ee6b4685..cf85b88b 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,13 @@ Hephaestus Logo -# Hephaestus -Hephaestus - A Generative AI Mentor for Agile Software Development +# Hephaestus: Leveraging Generative AI to Enhance Software Development Processes and Developer Training + +Hephaestus leverages generative AI, specifically large language models (LLMs), to enhance the software development lifecycle (SDLC) and developer training. This research project explores how AI can improve each phase of the SDLC — planning, analysis, design, implementation, testing & integration, and maintenance — while also providing comprehensive support for developer onboarding and continuous education. By integrating AI-driven insights and adaptive guidance into these processes, Hephaestus aims to boost efficiency, adherence to best practices, and overall software quality. The project also emphasizes support for agile methodologies, ensuring dynamic and iterative improvements to development workflows. Agile Hephaestus +Hephaestus /hɪˈfɛstəs/ is the Greek god of blacksmiths, craftsmen, and artisans, symbolizing the fusion of creativity and technical skill. + ## Documentation -The documentation can be found [here](https://ls1intum.github.io/Hephaestus/). \ No newline at end of file +The documentation can be found [here](https://ls1intum.github.io/Hephaestus/). diff --git a/docs/conf.py b/docs/conf.py index bbf2e7f1..3190be63 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,8 +37,8 @@ plantuml_output_format='svg' # java = 'JAVA_HOME' in os.environ and f"{os.environ['JAVA_HOME']}/bin/java" or 'java' -# local_plantuml_path = os.path.join(os.path.dirname(__file__), ) -plantuml = f"java -jar ./bin/plantuml.jar" +local_plantuml_path = os.path.join(os.path.dirname(__file__), 'bin/plantuml.jar') +plantuml = f'java -jar {local_plantuml_path}' # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/hephaestus.uml b/docs/hephaestus.uml deleted file mode 100644 index a4052ee2..00000000 --- a/docs/hephaestus.uml +++ /dev/null @@ -1,95 +0,0 @@ -@startuml -|Novice Developer| -start - -:Ideate and Plan; -:Create Issue; - -|Hephaestus| -:Review Issue; -while (Is the issue well-defined?) is (no) - :Provide Feedback on Issue; - |Novice Developer| - :Revise Issue; -endwhile (yes) -|Hephaestus| -:Approve Issue; - -|Novice Developer| -:Start Working on Issue; -:Create Branch; - -|Hephaestus| -:Monitor Development; -:Pair Programming Session; -fork - |Novice Developer| - :Implement Feature; - :Write Unit Tests; - :Commit Changes; - :Push Branch; -fork again - |Hephaestus| - :Provide Proactive Feedback; - :Guidance on Best Practices; -end fork - -|CI/CD Pipeline| -:Run Automated Tests; -if (Tests Pass?) then (no) - repeat - |Hephaestus| - :Review Failed Tests; - :Provide Feedback on Code; - |Novice Developer| - :Fix Issues; - :Push Branch; - |CI/CD Pipeline| - :Run Automated Tests; - repeat while (Tests Pass?) is (no) -else (yes) -endif - -|Hephaestus| -:Review Code; -if (Is the code up to standards?) then (yes) - :Approve Pull Request; -else (no) - :Provide Feedback on Code; -endif - -|Novice Developer| -:Merge Pull Request; - - -|CI/CD Pipeline| -:Deploy to Staging; - -|Novice Developer| -:Perform User Acceptance Testing; - -|Hephaestus| -:Monitor UAT Feedback; -if (Feedback is Positive?) then (yes) - :Deploy to Production; -else (no) - :Provide Feedback on UAT; - |Novice Developer| - :Revise Code; - |CI/CD Pipeline| - :Deploy to Staging; -endif - -|Novice Developer| -:Monitor Production; -:Gather Metrics; - -|Hephaestus| -:Review Metrics; -:Provide Continuous Feedback; - -|Novice Developer| -:Continuous Improvement; - -stop -@enduml diff --git a/docs/index.rst b/docs/index.rst index b26c16a0..79747bc2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,10 @@ .. _hephaestus: -================================================================== -Hephaestus - A Generative AI Mentor for Agile Software Development -================================================================== +===================================================================================================== +Hephaestus: Leveraging Generative AI to Enhance Software Development Processes and Developer Training +===================================================================================================== + +Hephaestus leverages generative AI, specifically large language models (LLMs), to enhance the software development lifecycle (SDLC) and developer training. This research project explores how AI can improve each phase of the SDLC — planning, analysis, design, implementation, testing & integration, and maintenance — while also providing comprehensive support for developer onboarding and continuous education. By integrating AI-driven insights and adaptive guidance into these processes, Hephaestus aims to boost efficiency, adherence to best practices, and overall software quality. The project also emphasizes support for agile methodologies, ensuring dynamic and iterative improvements to development workflows. .. figure:: ./images/agile_hephaestus.png :height: 250px @@ -10,31 +12,20 @@ Hephaestus - A Generative AI Mentor for Agile Software Development Hephaestus /hɪˈfɛstəs/ is the Greek god of blacksmiths, craftsmen, and artisans, symbolizing the fusion of creativity and technical skill. -Introduction -============ - -Hephaestus is designed to mentor novice developers in agile software development practices. The aim is to integrate Hephaestus into software engineering practical courses, extended university projects, and agile teams in the industry to help learn and apply agile methodologies. Unlike traditional educational tools that offer static content, Hephaestus provides dynamic, real-time guidance, adapting to individual and team needs. - -This approach is expected to foster a better understanding and application of agile principles among novice developers, preparing them more effectively for professional software development environments. Hephaestus fills a critical gap in educational technology by actively supporting and enhancing learning in complex, team-based settings. - -**Please note:** Hephaestus is currently in the concept and planning phase. The project aims to provide proactive guidance to novice developers, from planning a feature to delivering it to production and beyond. +.. uml:: ./use_cases.puml -.. getting_started/index -.. user_guide/index -.. api_reference/index -.. faq/index -.. contribute/index -.. uml_diagrams/index .. toctree:: - :maxdepth: 2 - :caption: Contents - - requirements_analysis/index - system_design/index - object_design/index - - -Rough UML Activity Diagram for Hephaestus -========================================= + :maxdepth: 3 + :caption: System Documentation + + system/planning/index + system/analysis/index + system/design/index + system/implementation/index + system/testing_and_integration/index + system/maintenance/index + system/training/index + system/collaboration/index + system/documentation/index + system/security/index -.. uml:: hephaestus.uml \ No newline at end of file diff --git a/docs/object_design/class_interfaces.rst b/docs/object_design/class_interfaces.rst deleted file mode 100644 index 162f3828..00000000 --- a/docs/object_design/class_interfaces.rst +++ /dev/null @@ -1,2 +0,0 @@ -Class Interfaces -================ \ No newline at end of file diff --git a/docs/object_design/glossary.rst b/docs/object_design/glossary.rst deleted file mode 100644 index 127899a8..00000000 --- a/docs/object_design/glossary.rst +++ /dev/null @@ -1,2 +0,0 @@ -Glossary -======== \ No newline at end of file diff --git a/docs/object_design/index.rst b/docs/object_design/index.rst deleted file mode 100644 index 67f7571f..00000000 --- a/docs/object_design/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -Object Design -============= - -This section covers the object design for Hephaestus, including class design, and state diagrams. - -.. toctree:: - :maxdepth: 2 - - introduction - packages - class_interfaces - glossary diff --git a/docs/object_design/introduction.rst b/docs/object_design/introduction.rst deleted file mode 100644 index fd2a946f..00000000 --- a/docs/object_design/introduction.rst +++ /dev/null @@ -1,2 +0,0 @@ -Introduction -============ \ No newline at end of file diff --git a/docs/object_design/packages.rst b/docs/object_design/packages.rst deleted file mode 100644 index 9230d78e..00000000 --- a/docs/object_design/packages.rst +++ /dev/null @@ -1,2 +0,0 @@ -Packages -======== \ No newline at end of file diff --git a/docs/requirements_analysis/functional_requirements.rst b/docs/requirements_analysis/functional_requirements.rst deleted file mode 100644 index bf96685e..00000000 --- a/docs/requirements_analysis/functional_requirements.rst +++ /dev/null @@ -1,2 +0,0 @@ -Functional Requirements (FRs) -============================= \ No newline at end of file diff --git a/docs/requirements_analysis/glossary.rst b/docs/requirements_analysis/glossary.rst deleted file mode 100644 index 127899a8..00000000 --- a/docs/requirements_analysis/glossary.rst +++ /dev/null @@ -1,2 +0,0 @@ -Glossary -======== \ No newline at end of file diff --git a/docs/requirements_analysis/index.rst b/docs/requirements_analysis/index.rst deleted file mode 100644 index 257f5714..00000000 --- a/docs/requirements_analysis/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -Requirements Analysis -===================== - -This section covers the requirements analysis for Hephaestus, including elicitation, analysis, and detailed specifications. - -.. toctree:: - :maxdepth: 2 - - introduction - proposed_system - functional_requirements - nonfunctional_requirements - system_models - glossary diff --git a/docs/requirements_analysis/introduction.rst b/docs/requirements_analysis/introduction.rst deleted file mode 100644 index fd2a946f..00000000 --- a/docs/requirements_analysis/introduction.rst +++ /dev/null @@ -1,2 +0,0 @@ -Introduction -============ \ No newline at end of file diff --git a/docs/requirements_analysis/nonfunctional_requirements.rst b/docs/requirements_analysis/nonfunctional_requirements.rst deleted file mode 100644 index c1ecbd1f..00000000 --- a/docs/requirements_analysis/nonfunctional_requirements.rst +++ /dev/null @@ -1,2 +0,0 @@ -Non-Functional Requirements (NFRs) -================================== \ No newline at end of file diff --git a/docs/requirements_analysis/proposed_system.rst b/docs/requirements_analysis/proposed_system.rst deleted file mode 100644 index 4d5a917e..00000000 --- a/docs/requirements_analysis/proposed_system.rst +++ /dev/null @@ -1,2 +0,0 @@ -Proposed System -=============== diff --git a/docs/requirements_analysis/system_models.rst b/docs/requirements_analysis/system_models.rst deleted file mode 100644 index 1590059a..00000000 --- a/docs/requirements_analysis/system_models.rst +++ /dev/null @@ -1,2 +0,0 @@ -System Models -============= \ No newline at end of file diff --git a/docs/system/analysis/index.rst b/docs/system/analysis/index.rst new file mode 100644 index 00000000..4d040705 --- /dev/null +++ b/docs/system/analysis/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Analysis +======== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/analysis/use_cases.puml b/docs/system/analysis/use_cases.puml new file mode 100644 index 00000000..faf4a94d --- /dev/null +++ b/docs/system/analysis/use_cases.puml @@ -0,0 +1,29 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor "Project Manager" as PM +actor Developer +actor "Product Owner" as PO + +rectangle "Hephaestus System - Analysis" { + usecase "Collect and Document Requirements" as CDR + usecase "Analyze and Validate Requirements" as AVR + usecase "Model System Behavior" as MSB + usecase "Define Acceptance Criteria" as DAC + usecase "Generate Analysis Reports" as GAR +} + +PM --> CDR +PM --> AVR +PM --> GAR + +Developer --> AVR +Developer --> MSB +Developer --> DAC + +PO -up-> CDR +PO -up-> AVR +PO -up-> DAC +@enduml diff --git a/docs/system/collaboration/index.rst b/docs/system/collaboration/index.rst new file mode 100644 index 00000000..fabf1ef0 --- /dev/null +++ b/docs/system/collaboration/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Collaboration +============= + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/collaboration/use_cases.puml b/docs/system/collaboration/use_cases.puml new file mode 100644 index 00000000..58389ac1 --- /dev/null +++ b/docs/system/collaboration/use_cases.puml @@ -0,0 +1,51 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "Project Manager" as PM +actor "Scrum Master" as SM +actor "Product Owner" as PO + +rectangle "Hephaestus System - Collaboration" { + usecase "Facilitate Stand-up Meetings" as FSM + usecase "Assist Sprint Planning" as ASP + usecase "Conduct Sprint Retrospectives" as CSR + usecase "Manage Sprint Backlogs" as MSB + usecase "Track Sprint Progress" as TSP + usecase "Generate Collaboration Insights" as GCI + usecase "Facilitate Cross-team Collaboration" as FCC + usecase "Schedule Collaboration Sessions" as SCS +} + +Developer --> FSM +Developer --> ASP +Developer --> CSR +Developer --> MSB +Developer --> TSP +Developer --> FCC + +PM -up--> ASP +PM -up--> MSB +PM -up--> TSP +PM -up--> GCI +PM -up--> FCC + +SM -up-> FSM +SM -up-> ASP +SM -up-> CSR +SM -up-> MSB +SM -up-> TSP +SM -up-> GCI +SM -up-> FCC +SM -up-> SCS + +PO ---> ASP +PO ---> CSR +PO ---> MSB +PO ---> TSP +PO ---> GCI +PO ---> FCC + +@enduml diff --git a/docs/system/design/index.rst b/docs/system/design/index.rst new file mode 100644 index 00000000..20e4722e --- /dev/null +++ b/docs/system/design/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Design +====== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/design/use_cases.puml b/docs/system/design/use_cases.puml new file mode 100644 index 00000000..2d859184 --- /dev/null +++ b/docs/system/design/use_cases.puml @@ -0,0 +1,39 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor "Project Manager" as PM +actor Developer +actor "Product Owner" as PO +actor "Scrum Master" as SM +actor "QA Engineer" as QA + +rectangle "Hephaestus System - Design" { + usecase "Define System Architecture" as DSA + usecase "Design Database Schema" as DDS + usecase "Create UI/UX Prototypes" as CUP + usecase "Review and Approve Designs" as RAD + usecase "Generate Design Documentation" as GDD + usecase "Validate Design" as VD +} + +PM -up-> DSA +PM -up-> RAD +PM -up--> GDD + +Developer --> DSA +Developer --> DDS +Developer --> CUP +Developer --> VD + +PO ---> CUP +PO ---> RAD +PO ---> VD + +SM --> RAD +SM --> VD + +QA -up-> RAD +QA -up-> VD +@enduml diff --git a/docs/system/documentation/index.rst b/docs/system/documentation/index.rst new file mode 100644 index 00000000..499235a3 --- /dev/null +++ b/docs/system/documentation/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Documentation +============= + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/documentation/use_cases.puml b/docs/system/documentation/use_cases.puml new file mode 100644 index 00000000..c45270a0 --- /dev/null +++ b/docs/system/documentation/use_cases.puml @@ -0,0 +1,58 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "Project Manager" as PM +actor "Scrum Master" as SM +actor "Product Owner" as PO +actor "QA Engineer" as QA + +rectangle "Hephaestus System - Documentation" { + usecase "Generate API Documentation" as GAD + usecase "Update Project Documentation" as UPD + usecase "Maintain User Manuals" as MUM + usecase "Create Technical Specifications" as CTS + usecase "Generate Release Notes" as GRN + usecase "Automate Documentation Updates" as ADU + usecase "Document Best Practices" as DBP + usecase "Create Training Materials" as CTM + usecase "Compile Knowledge Base" as CKB +} + +Developer --> GAD +Developer --> UPD +Developer --> MUM +Developer --> CTS +Developer --> ADU +Developer --> DBP +Developer --> CTM +Developer --> CKB + +PM ---> UPD +PM ---> GRN +PM ---> ADU +PM ---> DBP +PM ---> CKB + +SM -up---> UPD +SM -up---> ADU +SM -up---> DBP +SM -up---> CTM + +PO -up--> UPD +PO -up--> MUM +PO -up--> CTS +PO -up--> GRN +PO -up--> DBP +PO -up--> CKB + +QA -up-> GAD +QA -up-> UPD +QA -up-> MUM +QA -up-> GRN +QA -up-> ADU +QA -up-> DBP +QA -up-> CKB +@enduml diff --git a/docs/system/implementation/index.rst b/docs/system/implementation/index.rst new file mode 100644 index 00000000..5f02d884 --- /dev/null +++ b/docs/system/implementation/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Implementation +============== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/implementation/use_cases.puml b/docs/system/implementation/use_cases.puml new file mode 100644 index 00000000..1d7d5353 --- /dev/null +++ b/docs/system/implementation/use_cases.puml @@ -0,0 +1,54 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "Project Manager" as PM +actor "Scrum Master" as SM +actor "QA Engineer" as QA + +rectangle "Hephaestus System - Implementation" { + usecase "Assist Pair Programming" as APP + usecase "Automate Code Review" as ACR + usecase "Assess Code Quality" as ACQ + usecase "Define and Maintain Best Practices" as DMBP + usecase "Monitor Guideline Adherence" as MGA + usecase "Provide Code Examples" as PCE + usecase "Suggest Refactoring" as SR + usecase "Generate Implementation Docs" as GID + usecase "Support Continuous Integration" as SCI + usecase "Analyze Performance" as AP + usecase "Conduct Security Checks" as CSC + usecase "Facilitate Code Reviews" as FCR +} + +Developer --> APP +Developer --> ACR +Developer --> ACQ +Developer --> DMBP +Developer --> MGA +Developer --> PCE +Developer --> SR +Developer --> GID +Developer --> SCI +Developer --> AP +Developer --> CSC +Developer --> FCR + +PM -up--> DMBP +PM -up--> MGA +PM -up--> GID +PM -up--> SCI + +SM -up-> APP +SM -up-> DMBP +SM -up-> MGA +SM -up-> SCI + +QA -up-> ACR +QA -up-> ACQ +QA -up-> AP +QA -up-> CSC +QA -up-> FCR +@enduml diff --git a/docs/system/maintenance/index.rst b/docs/system/maintenance/index.rst new file mode 100644 index 00000000..b2a15229 --- /dev/null +++ b/docs/system/maintenance/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Maintenance +=========== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/maintenance/use_cases.puml b/docs/system/maintenance/use_cases.puml new file mode 100644 index 00000000..b7bdd460 --- /dev/null +++ b/docs/system/maintenance/use_cases.puml @@ -0,0 +1,44 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "Project Manager" as PM +actor "QA Engineer" as QA +actor "Security Analyst" as SA + +rectangle "Hephaestus System - Maintenance" { + usecase "Track and Resolve Bugs" as TRB + usecase "Monitor System Performance" as MSP + usecase "Perform System Upgrades" as PSU + usecase "Apply Security Patches" as ASP + usecase "Generate Maintenance Reports" as GMR + usecase "Database Maintenance" as DM + usecase "Backup and Recovery" as BR + usecase "Provide User Support" as PUS + usecase "Manage Software Configuration" as MSC +} + +Developer --> TRB +Developer --> MSP +Developer --> PSU +Developer --> ASP +Developer --> DM +Developer --> BR +Developer --> PUS +Developer --> MSC + +PM -up-> TRB +PM -up-> MSP +PM -up-> PSU +PM -up-> GMR +PM -up-> BR +PM -up-> MSC + +QA -up-> TRB +QA -up-> MSP + +SA -up-> ASP +SA -up-> MSC +@enduml diff --git a/docs/system/planning/index.rst b/docs/system/planning/index.rst new file mode 100644 index 00000000..143d81bd --- /dev/null +++ b/docs/system/planning/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Planning +======== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/planning/use_cases.puml b/docs/system/planning/use_cases.puml new file mode 100644 index 00000000..695ee31f --- /dev/null +++ b/docs/system/planning/use_cases.puml @@ -0,0 +1,42 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor "Product Owner" as PO +actor "Project Manager" as PM +actor "Scrum Master" as SM +actor Developer + +rectangle "Hephaestus System - Planning" { + usecase "Prioritize Backlog Items" as PBI + usecase "Assist Sprint Planning" as ASP + usecase "Create Project Timeline" as CPT + usecase "Generate Planning Reports" as GPR + usecase "Identify and Mitigate Risks" as IMR + usecase "Plan Resource Allocation" as PRA + usecase "Estimate Effort and Costs" as EEC + usecase "Define Project Goals and Scope" as DPGS +} + +PM --> DPGS +PM --> EEC +PM --> PRA +PM --> IMR +PM --> GPR +PM --> CPT + +Developer --> EEC +Developer --> PRA +Developer --> ASP +Developer --> PBI + +PO -up-> DPGS +PO -up-> IMR +PO -up-> ASP +PO -up-> PBI + +SM --up-> CPT +SM --up-> GPR +SM --up-> ASP +@enduml diff --git a/docs/system/security/index.rst b/docs/system/security/index.rst new file mode 100644 index 00000000..414977a5 --- /dev/null +++ b/docs/system/security/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Security +======== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/security/use_cases.puml b/docs/system/security/use_cases.puml new file mode 100644 index 00000000..8fe3c33d --- /dev/null +++ b/docs/system/security/use_cases.puml @@ -0,0 +1,43 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "Security Analyst" as SA +actor "QA Engineer" as QA + +rectangle "Hephaestus System - Security" { + usecase "Identify Security Vulnerabilities" as ISV + usecase "Conduct Security Audits" as CSA + usecase "Apply Security Patches" as ASP + usecase "Monitor Security Compliance" as MSC + usecase "Generate Security Reports" as GSR + usecase "Conduct Penetration Testing" as CPT + usecase "Implement Best Security Practices" as IBSP + usecase "Incident Response" as IR + usecase "Continuous Security Monitoring" as CSM + usecase "Provide Security Training" as PST +} + +Developer --> ISV +Developer --> ASP +Developer --> IBSP +Developer --> IR + +SA -up-> ISV +SA -up-> CSA +SA -up-> ASP +SA -up-> MSC +SA -up-> GSR +SA -up-> CPT +SA -up-> IBSP +SA -up-> IR +SA -up-> CSM +SA -up-> PST + +QA --> ISV +QA --> CPT +QA --> CSM + +@enduml diff --git a/docs/system/testing_and_integration/index.rst b/docs/system/testing_and_integration/index.rst new file mode 100644 index 00000000..46f238d2 --- /dev/null +++ b/docs/system/testing_and_integration/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Testing and Integration +======================= + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/testing_and_integration/use_cases.puml b/docs/system/testing_and_integration/use_cases.puml new file mode 100644 index 00000000..c1991f01 --- /dev/null +++ b/docs/system/testing_and_integration/use_cases.puml @@ -0,0 +1,46 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "QA Engineer" as QA +actor "Scrum Master" as SM +actor "Project Manager" as PM + +rectangle "Hephaestus System - Testing & Integration" { + usecase "Generate Automated Tests" as GAT + usecase "Manage Test Cases" as MTC + usecase "Execute Tests" as ET + usecase "Support Manual Testing" as SMT + usecase "Track Bugs" as TB + usecase "Integrate with CI/CD" as ICC + usecase "Generate Test Reports" as GTR + usecase "Conduct Regression Testing" as CRT + usecase "Conduct Performance Testing" as CPT + usecase "Conduct Security Testing" as CST +} + +Developer --> GAT +Developer --> ET +Developer --> ICC +Developer --> CRT + +QA -up-> GAT +QA -up-> MTC +QA -up-> ET +QA -up-> SMT +QA -up-> TB +QA -up-> GTR +QA -up-> CRT +QA -up-> CPT +QA -up-> CST + +SM --> ICC + +PM --> MTC +PM --> TB +PM --> GTR +PM --> CPT +PM --> CST +@enduml diff --git a/docs/system/training/index.rst b/docs/system/training/index.rst new file mode 100644 index 00000000..44cdae6c --- /dev/null +++ b/docs/system/training/index.rst @@ -0,0 +1,6 @@ +.. _hephaestus: + +Training +======== + +.. uml:: ./use_cases.puml \ No newline at end of file diff --git a/docs/system/training/use_cases.puml b/docs/system/training/use_cases.puml new file mode 100644 index 00000000..ec4c580d --- /dev/null +++ b/docs/system/training/use_cases.puml @@ -0,0 +1,48 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor Developer +actor "Project Manager" as PM +actor "Scrum Master" as SM +actor "Product Owner" as PO + +rectangle "Hephaestus System - Training" { + usecase "Developer Training" as UC1 + usecase "Onboard New Developers" as UC2 + usecase "Provide Learning Resources" as UC3 + usecase "Track Training Progress" as UC4 + usecase "Generate Training Reports" as UC5 + usecase "Conduct Training Sessions" as UC6 + usecase "Offer Mentorship Programs" as UC7 + usecase "Manage Certification Programs" as UC8 + usecase "Evaluate Skill Levels" as UC9 +} + +Developer --> UC1 +Developer --> UC2 +Developer --> UC3 +Developer --> UC4 +Developer --> UC5 +Developer --> UC6 +Developer --> UC7 +Developer --> UC8 +Developer --> UC9 + +PM -up-> UC1 +PM -up-> UC4 +PM -up-> UC5 +PM -up-> UC6 + +SM -up-> UC2 +SM -up-> UC3 +SM -up-> UC6 +SM -up-> UC7 + +PO -up-> UC3 +PO -up--> UC4 +PO -up-> UC7 +PO -up-> UC8 + +@enduml \ No newline at end of file diff --git a/docs/system_design/glossary.rst b/docs/system_design/glossary.rst deleted file mode 100644 index 127899a8..00000000 --- a/docs/system_design/glossary.rst +++ /dev/null @@ -1,2 +0,0 @@ -Glossary -======== \ No newline at end of file diff --git a/docs/system_design/index.rst b/docs/system_design/index.rst deleted file mode 100644 index 749eda32..00000000 --- a/docs/system_design/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -System Design -============= - -This section covers the system design for Hephaestus, including architectural, component, and interface design. - -.. toctree:: - :maxdepth: 2 - - introduction - proposed_architecture - subsystem_services - glossary diff --git a/docs/system_design/introduction.rst b/docs/system_design/introduction.rst deleted file mode 100644 index fd2a946f..00000000 --- a/docs/system_design/introduction.rst +++ /dev/null @@ -1,2 +0,0 @@ -Introduction -============ \ No newline at end of file diff --git a/docs/system_design/proposed_architecture.rst b/docs/system_design/proposed_architecture.rst deleted file mode 100644 index f931e497..00000000 --- a/docs/system_design/proposed_architecture.rst +++ /dev/null @@ -1,2 +0,0 @@ -Proposed Architecture -===================== \ No newline at end of file diff --git a/docs/system_design/subsystem_services.rst b/docs/system_design/subsystem_services.rst deleted file mode 100644 index 4d075902..00000000 --- a/docs/system_design/subsystem_services.rst +++ /dev/null @@ -1,2 +0,0 @@ -Subsystem Services -================== \ No newline at end of file diff --git a/docs/use_cases.puml b/docs/use_cases.puml new file mode 100644 index 00000000..b5913ae5 --- /dev/null +++ b/docs/use_cases.puml @@ -0,0 +1,44 @@ +@startuml +left to right direction +skinparam backgroundColor transparent +skinparam packageStyle rectangle + +actor "Developer" as Dev +actor "Project Manager" as PM +actor "Scrum Master" as SMaster +actor "Product Owner" as PO +actor "QA Engineer" as QA +actor "Security Analyst" as Sec + +actor "Team Member" as TM + +TM <|-up- Sec +TM <|-up- QA +TM <|-up- Dev +TM <|-up- SMaster +TM <|-up- PM +TM <|-up- PO + +rectangle "Hephaestus System" { + usecase "Provide Training & Onboarding" as PTO + usecase "Facilitate Collaboration" as FC + usecase "Enhance Security Practices" as ESP + usecase "Streamline Maintenance" as SM + usecase "Optimize Testing & Integration" as OT + usecase "Support Implementation" as SI + usecase "Maintain Documentation" as MD + usecase "Assist Design" as AD + usecase "Enhance Analysis" as EA + usecase "Support Planning" as SP +} + +TM --> PTO +TM --> FC +TM --> ESP +TM --> SM +TM --> OT +TM --> SI +TM --> MD +TM --> AD +TM --> EA +TM --> SP \ No newline at end of file