Polykey-Docs 1.0 Epic: Development of Theory Documentation #81
Description
WIP
Goals and Objectives
Objective: Develop and enhance the Theory section of Polykey’s documentation to provide users with in-depth theoretical knowledge that supports their understanding and use of Polykey. This documentation will delve into the concepts and principles underlying the practical applications covered in the How-To Guides and Tutorials.
Specific Goals:
- Depth and Clarity: Ensure the Theory documentation offers comprehensive insights into the foundational theories that underpin Polykey's functionalities.
- Support Practical Use: Link theoretical content to practical examples where possible, to help users connect theory with practice.
- Engagement and Accessibility: Make complex theoretical content engaging and accessible through clear writing, effective organization, and appropriate visual aids.
Current Documentation Evaluation
- Content Audit: Conduct a thorough review of existing Theory documentation to assess its accuracy, relevance, and completeness.
- User Feedback: Gather feedback from users about the current Theory content to identify gaps and areas for improvement.
- Technical Review: Involve subject matter experts to ensure the content is technically sound and up-to-date.
Potential and Confirmed Topics for Theory
This section will serve as a dynamic area for brainstorming potential topics, evaluating their relevance and demand, and confirming topics for development.
Evaluation Process
- Review current state of Theory documentation & Create subsequent sub-tickets and necessary discussion
- Review excalidraw documentation to evaluate other topics for covering
Topics Under Consideration:
- Cryptographic Fundamentals: Explore the cryptographic principles that secure data within Polykey.
- Security Models: Discuss various security models and architectures that influence Polykey’s design.
- Network Security Protocols: Detailed explanation of the protocols Polykey uses to secure communication across networks.
- Distributed Systems and Consensus Algorithms: An in-depth look at how Polykey manages distributed systems.
Confirmed Topics:
- Principles of Secret Management: Discuss the theoretical underpinnings of secret management within Polykey and its applications.
Specifications for Implementation
Once a topic is confirmed:
- Detailed Outline: Develop a detailed outline for each Theory document, specifying key concepts, expected structure, and supporting materials.
- Resource Allocation: Determine the resources needed for each topic, including technical writers, subject matter experts, and graphic designers for diagrams and visual aids.
- Development Timeline: Establish timelines for the writing, reviewing, and publishing phases.
Linking and Tracking
- Sub-Issues for Each Topic: Create detailed sub-issues for each confirmed theory topic. These sub-issues will outline specific tasks related to content development and ensure detailed tracking and accountability.