-
-
Notifications
You must be signed in to change notification settings - Fork 384
Kwickerhub’s Organization Proposal
Update KWICKERHUB Contributor Guide
Kwickerhub (current version 1.0.0, first release in 2020) is an open-source organization that provides a drag-and-drop website creation tool using the approach of visual programming in building web pages. Our platform is unique in that we believe in the power of modules, such as grids, sliders, designed tables, image carousels, etc., instead of just templates. Our mission is to make the creation of web applications less stressful, much faster, and more efficient for designers, content creators, template makers, and front-end engineers. We're also planning to create a tool for back-end engineers soon. Kwickerhub is free to use, and we hope to become a major competitor to sites like WordPress or Figma.
Kwickerhub is an open-source project that provides tools for front-end engineers and designers to create more efficient and enhanced web pages and designs in less time. Our mission is to empower web developers and designers by providing them with the necessary tools to speed up their workflow and reduce development time, without sacrificing the quality of their work.
Our vision is to become the go-to resource for front-end developers and designers worldwide, providing them with a platform that enables them to build high-quality websites and web applications in less time and with less effort. We believe that by providing these tools, we can help developers and designers focus on what they do best - creating great user experiences.
Kwickerhub is the next big project for several reasons. Firstly, our tools are designed to make the lives of front-end developers and designers easier and more efficient, which is a pressing need in the industry. Secondly, our open-source model allows us to tap into the collective knowledge and expertise of the community, which means that we can constantly improve and iterate on our tools.
Finally, we believe that our project would be a great fit for Google Season of Docs. Our tools have the potential to benefit a wide range of developers and designers, and we believe that working with Google Season of Docs would allow us to reach an even wider audience. We are committed to creating high-quality documentation that is easy to use and understand, and we believe that this is an area where we can make a significant contribution to the community.
We have several project ideas for technical writers to work on during the Google Season of Docs program, including these:
KwickerHub aims to provide an easy-to-use drag-and-drop website creation tool that implements the approach of visual programming in building web pages. The user documentation project will focus on providing clear, concise, and comprehensive documentation to help users get started with the tool, as well as guidance on best practices and advanced techniques.
As an open-source project, KwickerHub values transparency and open communication. The technical documentation project will focus on providing detailed documentation for contributors to the project. This will include information on the architecture and design of the tool, as well as detailed documentation on the codebase and how to contribute to the project.
KwickerHub plans to create a tool for back-end engineers in the future. As part of this, they will be developing an API that will allow developers to extend the functionality of the tool. The API documentation project will focus on providing clear and comprehensive documentation on the available APIs, as well as guidance on best practices for using them.
Generally, the technical writers will work with the engineering team to
Create a comprehensive user guide that covers all features and uses cases of Kwickerhub's platform
Develop API documentation for Kwickerhub's developers
Create a troubleshooting guide that addresses common user issues and provides solutions
Improve the overall organization and structure of the documentation to make it more accessible and user-friendly
Ensure that all documentation is accurate, up-to-date, and follows industry best practices
To evaluate the success of Kwickerhub during the Google Season of Docs program, we'll use a combination of metrics and feedback mechanisms. Metrics will include the number of technical writers who apply to work with us, the number of projects completed, and the number of users who access our documentation during the program. We'll also collect feedback from technical writers, mentors, and users to identify areas where we can improve our documentation and platform. We'll use this feedback to make improvements to our documentation and to plan future development projects.
The project is expected to last for three months, starting on March 31st and ending on June 31st. The following is a breakdown of the timeline for the project:
Week 1-2: Familiarization with our product, including reviewing existing documentation, interviewing key personnel, and attending training sessions.
Week 3-8: Creation of user manual, tutorials, and guides, including drafting, reviewing, and revising content.
Week 9-10: Creation of API documentation, including drafting, reviewing, and revising content.
Week 11-12: Final review and editing of all documentation, including testing of documentation to ensure accuracy and completeness.
| Budget item | Amount ($) | Running Total | Notes |
|---|---|---|---|
| Technical writer compensation:Compensation for the technical writers to produce documentation and conduct knowledge transfer sessions for Kwickerhub | 4000 | 4000 | |
| Volunteer stipends | 250 | 500.00 | 2 volunteer stipends x 250 each |
| Project t-shirts (10 t-shirts) | 100 | 500.00 | 5 project t-shirts x 100 each |
| Contingency fund | 1000 | 1000.00 | Fund to cover unforeseen expenses or overruns |
| TOTAL | 6,000.00 |
We believe that the Season of Docs program is an excellent opportunity for us to improve the documentation of our product, and we are excited to participate in this program. We are confident that with the help of technical writers, we can provide our clients with clear and concise documentation that will help them get the most out of our software. Thank you for considering our proposal.