You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -621,7 +621,7 @@ Use the following steps to complete this task:
621
621
622
622
1. Monitor GitHub Copilot's response.
623
623
624
-
GitHub Copilot will analyze the `spec.md` file and generate clarification questions.
624
+
GitHub Copilot will analyze the spec.md file and generate clarification questions.
625
625
626
626
For example, you may receive questions that are similar to the following:
627
627
@@ -633,25 +633,23 @@ Use the following steps to complete this task:
633
633
634
634
The questions will be presented one at a time.
635
635
636
-
1. Take the appropriate time to consider each question before answering.
636
+
1. Consider each question appropriately before answering.
637
637
638
-
In a production environment, your answers should reflect careful analysis of business needs, user experience considerations, and technical constraints.
638
+
In a production environment, your answers should reflect careful analysis of business needs, user experience considerations, and technical constraints. However, for this training, you can selected the recommended option for each question.
639
639
640
-
For this training, you can selected the recommended option for each question.
641
-
642
-
After you provide each answer, GitHub Copilot updates the `spec.md` file with clarifications.
640
+
When you provide an answer, GitHub Copilot updates the spec.md file with clarifications.
643
641
644
642
> **NOTE**: If Copilot presents additional rounds of questions, continue answering until it indicates there are no further clarifications needed. The clarification process typically involves 1-2 rounds of questions as Copilot refines the specification.
645
643
646
-
1. Once the clarification process is complete, review the updated `spec.md` file, and then accept the changes.
644
+
1. Once the clarification process is complete, review the updated **spec.md** file, and then accept the changes.
647
645
648
646
- Check that your answers are accurately reflected in the specification
649
647
- Verify that previously ambiguous areas now have clear requirements
650
648
- Look for any newly added acceptance criteria based on your clarifications
651
649
652
650
You can make any manual edits if needed. For example, if GitHub Copilot interpreted an answer differently than you intended, edit the spec directly to correct it.
653
651
654
-
1. Save the updated `spec.md` file and commit your changes.
652
+
1. Save the updated **spec.md** file and commit your changes.
655
653
656
654
The clarified specification now provides comprehensive guidance for implementation. By addressing ambiguities upfront, you reduce the risk of building the wrong solution or having to make significant changes later in the development process.
657
655
@@ -663,170 +661,82 @@ In this task, you use GitHub Copilot's `/speckit.plan` command to generate a com
663
661
664
662
Use the following steps to complete this task:
665
663
666
-
1. Ensure the Copilot Chat view is open (press **Ctrl+Alt+I** if needed).
667
-
668
-
1. In the Chat input field, enter the `/speckit.plan` command and press **Enter**.
664
+
1. Ensure the Copilot Chat view is open..
669
665
670
-
1. GitHub Copilot will analyze the `constitution.md` and `spec.md` files to generate the plan. It may prompt you for additional technical context. Provide the following information:
666
+
1. In the Chat view, to start the technical planning process, enter the following command:
671
667
672
-
```plaintext
673
-
Technology Stack Context:
674
-
675
-
Backend: ASP.NET Core 8.0 Web API with C#, Entity Framework Core 8
676
-
Database: Azure SQL Database
677
-
Storage: Azure Blob Storage for document files
678
-
Authentication: Microsoft Entra ID with JWT tokens
679
-
Hosting: Azure App Service
680
-
681
-
Architecture:
682
-
- Repository pattern for data access
683
-
- Service layer for business logic
684
-
- Dependency Injection
685
-
- DTOs for API contracts
686
-
687
-
Development:
688
-
- Async/await for all I/O operations
689
-
- Unit tests with xUnit
690
-
- XML documentation for public APIs
691
-
- Application Insights for logging
668
+
```dotnetcli
669
+
/speckit.plan
692
670
```
693
671
694
-
1. Wait 2-3 minutes for GitHub Copilot to generate the technical plan in the `plan.md` file.
672
+
1. Monitor GitHub Copilot's response and provide assistance in the Chat view.
695
673
696
-
1. Open the `plan.md` file from the EXPLORER view and verify it includes these sections:
674
+
GitHub Copilot will analyze the constitution.md and spec.md files to generate the plan. Provide permission and assistance when required.
697
675
698
-
- **Architecture Overview**: High-level system design and component interactions
699
-
- **Technology Stack**: Specific versions and frameworks to be used
700
-
- **Data Model**: Database schema, entities, and relationships
- Specifies Entity Framework Core with repository pattern
691
+
1. After reviewing the files, accept the updates.
740
692
741
-
1. Verify the plan includes implementation phases or milestones. For example:
693
+
If the plan omits important details or makes assumptions you disagree with, you can:
742
694
743
-
- **Phase 1**: Database schema and models (Week 1)
744
-
- **Phase 2**: Azure Blob Storage integration and file upload API (Week 2-3)
745
-
- **Phase 3**: Document listing, search, and filtering (Week 4)
746
-
- **Phase 4**: Version management and sharing features (Week 5-6)
747
-
- **Phase 5**: Dashboard integration and notifications (Week 7)
748
-
- **Phase 6**: Testing, security review, and deployment (Week 8-10)
749
-
750
-
1. If the plan omits important details or makes assumptions you disagree with, you can:
751
-
752
-
- Edit the `plan.md` file directly, or
695
+
- Edit the plan.md file directly, or
753
696
- Ask follow-up questions in Copilot Chat. For example:
754
697
755
698
```plaintext
756
699
The plan should include a background job for processing virus scans. Add details about using Azure Functions with Queue Storage triggers to handle async file scanning after upload.
757
700
```
758
701
759
-
1. Save the `plan.md` file and commit your changes:
760
-
761
-
```powershell
762
-
git add plan.md
763
-
git commit -m "Add technical implementation plan for document management feature"
764
-
git push
765
-
```
702
+
1. Save the files, and then commit and sync your changes.
766
703
767
704
The technical plan now serves as a blueprint for implementation. It translates business requirements into concrete technical decisions while respecting organizational constraints. This plan will guide the creation of actionable tasks in the next step.
768
705
769
-
## Create the Task List
706
+
## Create the task list
770
707
771
708
The task list breaks down the technical plan into specific, actionable implementation steps. Each task should be small enough to complete in a reasonable timeframe (typically a few hours to a day) and have clear acceptance criteria.
772
709
773
710
In this task, you use GitHub Copilot's `/speckit.tasks` command to generate a comprehensive task list.
774
711
775
712
Use the following steps to complete this task:
776
713
777
-
1. Ensure the Copilot Chat view is open (press **Ctrl+Alt+I** if needed).
778
-
779
-
1. In the Chat input field, enter the `/speckit.tasks` command and press **Enter**.
780
-
781
-
1. GitHub Copilot will analyze the `plan.md` file and generate tasks in the `tasks.md` file. Wait 1-2 minutes for the generation to complete.
714
+
1. Ensure the Copilot Chat view is open.
782
715
783
-
1. Open the `tasks.md` file from the EXPLORER view.
716
+
1. In the Chat view, to start generating the task list, enter the following command:
784
717
785
-
1. Review the generated task list. It should include tasks such as:
718
+
```dotnetcli
719
+
/speckit.tasks
720
+
```
786
721
787
-
**Data Model (5 tasks):**
788
-
- [ ] Task 1: Create Document entity with EF Core model
- Individual tasks should be completable in a few hours to a day
845
755
- If a task seems too large, note that it may need to be broken down during implementation
846
756
847
-
1. Add task dependencies or notes if needed. For example:
757
+
You can add task dependencies or notes if needed. For example:
848
758
849
759
```markdown
850
760
- [ ] Task 12: Implement DocumentController POST /api/documents endpoint
851
761
- Depends on: Task 11 (DocumentService)
852
762
- Note: Include comprehensive error handling for file size limits and unsupported types
853
763
```
854
764
855
-
1. Save the `tasks.md` file and commit your changes:
856
-
857
-
```powershell
858
-
git add tasks.md
859
-
git commit -m "Add comprehensive task list for document management implementation"
860
-
git push
861
-
```
765
+
1. Save the `tasks.md` file, and then commit and sync your changes.
862
766
863
767
The task list now provides a clear roadmap for implementation. In the next task, you'll use GitHub Copilot to help implement these tasks systematically.
864
768
@@ -870,14 +774,14 @@ In this task, you'll implement a subset of the feature to demonstrate the spec-d
870
774
871
775
Use the following steps to complete this task:
872
776
873
-
1. Review the task list in `tasks.md` and identify foundational tasks to implement:
777
+
1. Review the task list in tasks.md and identify foundational tasks to implement:
874
778
875
779
- Task 1: Create Document entity
876
780
- Task 6: Implement upload service
877
781
- Task 7: Create upload API endpoint
878
782
- Task 14: Create upload UI component
879
783
880
-
1. **Create the Document entity model:**
784
+
1. Create the Document entity model
881
785
882
786
In Visual Studio Code, create a new file in the existing `ContosoDashboard/Models/` folder: `ContosoDashboard/Models/Document.cs`
883
787
@@ -896,7 +800,7 @@ Use the following steps to complete this task:
896
800
897
801
Position your cursor after the comment and press **Enter**. GitHub Copilot should generate the entity class. Review and accept the suggestion, or refine it as needed.
898
802
899
-
1. **Implement the document upload service:**
803
+
1. Implement the document upload service
900
804
901
805
Create a new file in the existing `ContosoDashboard/Services/` folder: `ContosoDashboard/Services/DocumentService.cs`
0 commit comments