entity icon indicating copy to clipboard operation
entity copied to clipboard

Create Technical Standards Documentation on Developer Connect Website

Open pwei1018 opened this issue 1 year ago • 0 comments

Description: We need to establish a dedicated section on the Developer Connect website to host technical standards documentation. This section will serve as a centralized, accessible resource for developers to reference coding standards, best practices, and guidelines. The documentation will cover various topics, including code style, version control, testing requirements, and security practices. This will help promote consistency, quality, and maintainability across development projects.

Objectives:

  1. Structure and Content: Define the structure for the technical standards section, ensuring it is easy to navigate and understand.
  2. Draft Content: Collaborate with developers, DevOps, and security teams to draft the initial content for each topic.
  3. Website Integration: Integrate this documentation into the Developer Connect website, ensuring a user-friendly layout.
  4. Review and Feedback: Share the draft content with the development team for feedback and make necessary revisions.
  5. Ongoing Maintenance Plan: Develop a plan for keeping the technical standards up-to-date as best practices evolve.

Acceptance Criteria:

  • [ ] The technical standards section is live on the Developer Connect website.

  • [ ] Documentation includes all agreed-upon technical standards, is organized logically, and is accessible.

  • [ ] Feedback from initial reviewers has been incorporated.

  • [ ] Plan for regular reviews and updates to documentation is established.

pwei1018 avatar Nov 01 '24 18:11 pwei1018