This is a cookiecutter template for writing project based on Five Steps to Successful Writing from Handbook of Technical Writing 9th ed. This template is designed to help you jump-start your writing project and make every writing project that you're working on consistent.
Because when you are writing, you are trying to convey your idea, perception, or model to your reader. Therefore after your audience read your writing they should be able to decode your writing into idea, perception, and model inside their head. And the more effective your writing there should be more overlap of idea, perception, and model that you are trying to convey and the one that they internalize.
It is actually a chapter from Handbook of Technical Writing by Arled, Brusaw, and Oliu. If you can not access this book there are various similar materials on the internet if you use Five Steps to Successful Writing as the keywords. It consists of five steps that you can use to achieve effective writing, those steps are:
- Preparation/Planning
- Establish your primary purpose
- Assess your audience and the context
- Determine the scope of your coverage
- Select the appropriate medium
- Research
- Describe methods of research
- Enumerate sources of information
- Organization
- Choose a primary method of development
- Outlining
- Writing
- Revising
And, all of these tasks can be tedious. Moreover it is easy to have a messy and inconsistent directory that filled with cluttered files with arbitrary names. This template help you to deal with these kind of problem.
Make sure you already have cookiecutter installed. Then run:
cookiecutter gh:radifar/overlap-cookiecutter
There will be a prompt that ask the writing project name, date, and author name. Just fill those prompt accordingly. If everything works correctly, you will have a new directory with the name of current local date + slugified writing project title.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
