Peer Feedback Response to #222: VnV Plan - Section 2.3, Custom Documents

Open Beginner friendly
#315 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
66/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
tex
Domain
documentation

Research direction

Locate Section 2.3, “Custom Documents,” in the VnV Plan and read the Feature Oriented Domain Analysis Report and usability report sections, along with the survey in the appendix. Expand the section to explain how each custom document supports verification and validation, and link the usability report to the survey; the feedback from #222 should be addressed.

Written by the indexing model from the issue text.

Description

documentation Feedback Response Revision

Description of the Feedback

The following feedback was provided:

There should be more direct identification of the benefit to the verification and validation of the chosen custom documents
Relating the CDs to the parts of the plan they support strengthens the section
The usability report section should also link to the survey designed in the appendix
Closing Remarks
Content is good, but the Feature Oriented Domain Analysis Report section could be more in depth, providing more information makes it clearer to what in the project's VnV it will support. Same goes for the usability report, but connection to the survey will already make it clearer

Covers feedback of #222

Actions to be taken

  • Add more detail to this section to outline the purpose and benefits of the custom documents
Dominant language
TeX
Stars
0
Forks
0
Avg merge
1d 7h
Merged PRs (30d)
52

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Aeolus-Software/RealmForge

All issues in Aeolus-Software/RealmForge

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.