Hackability Documentation Tool
This projects enable users to document their Hackability project and share it with the web
- level simple
- time 1 hours, 25 min
- license CC-BY-SA
Why you made it?
Documenting is hard, and we need a tool to enabling users to document their hackability projects.
What is it dong?
The project is a simple web application that enables users participating to an hackability event to document in a standard way their project!
How the object is made?
This is a simple web application developed with Angular(5) and Typescript. The app generates a Jekyll compatible project that can be upload on GitLab
Documenting is hard, and probably it’s the hardest part of an open source project.
With docs.hackability, we want to provide a simple and zero-cost product helping people documenting their project!
What I need to build it?
- A simple PC with internet connecting
- Some time
Step 1 Think!
In order to suceffully document your project, you need to think and answer to some questions. This will help you to write good documentation.
The whestions are:
- Why you build this project? Which are the problem this project solved?
- What the projects does? How it works?
- What are the main features of the project?
Step 2 Choose Your License
You need to decide how users can use and improve your project, and set up a license!
Choosing a good license is difficult, and often you have no time to dedicate to study all the difference licenses available. So we simplify you life!!
All Hackability project will be release under Creative Common (CC) license, Attribution (BY) Share Alike (SA). This means that all contributors to your project have to:
- Mention you as original author of the project
- Share the evolution of the project with the same license.
You can choose to not enable contributors to make commercial activity with your project or with any avolution to the project, by adding the Non Commercial (NC) option.
This is up to you, but we suggest not to add NC to your project if you want to encourage diffusion of the project!
I need someone who can help me improve this step!
How can you help me?
- Write better stuff
- Grammar check
Step 3 Divide et Impera
This is the hardest part: you need to understand how to divide the construction process of your project in atomic steps and describe carefully each step.
In this way, you’ll be able to enable other users to replicate and improve your work!
- Ludovico Russo ludusrusso developed the main user interface of this tool and the jekyll site able to render it!