generator-pm

Yeoman generator for Project Management and Documentation Repository.
Project Management and Documentation Repository is just a folder where you can keep all project specs, notes and tasks in form of regular files: text, images and any others.
"pm" stays for "Project Management".

Installation and Usage

1. Create directory for your documentation repository and navigate there

   mkdir <DOC_REPO_NAME>
   cd <DOC_REPO_NAME>

2. Install Yeoman (we assume you have pre-installed node.js)

   npm install -g yo

3. Install generator-pm using npm. You have 2 options here:

   • global installation (to use generator-pm multiple times for different projects)

     npm install -g generator-pm

   • local installation (to use it only while you are in current_project_folder)

     npm install generator-pm

4. Run generator

   yo pm

5. Follow the prompts

   After this you should see in your output something like this

   create README.md
   create .gitignore
   create Design/README.md
   create Journal/README.md
   create Research/README.md
   create Team/README.md
   create Task-management/README.md
   create Task-management/1-backlog/.gitkeep
   create Task-management/2-progress/.gitkeep
   create Task-management/3-done/.gitkeep
   create Task-management/4-canceled/.gitkeep
   create Test/README.md

6. That's it. Now you can add and store the documentation and all of your notes in organized way.

Generated Files Structure (as for v1.0.0 of npm package)

├── README.md
├── .gitignore

├── Design
│   └── README.md

├── Journal
│   └── README.md

├── Research
│   └── README.md

├── Task-management
│   ├── 1-backlog
│   ├── 2-progress
│   ├── 3-done
│   ├── 4-canceled
│   └── README.md

├── Team
│   └── README.md

└── Test
│   └── README.md

License

Apache-2.0 © Vlad Zamskoi

Thanks

To Carsten Dominik for the idea of Emacs Org-mode — a system for note-taking and project planning.
References:

• http://orgmode.org/
• https://www.youtube.com/watch?v=oJTwQvgfgMM