practicalli / practicalli/practicalli.github.io
technical writing
Open
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 7
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
article on how to create great technical writing
Tools
- https://hemingwayapp.com/ - improve readability of prose
- Alex - feedback on neutral language
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the requested article topic and review the listed Hemingway Editor and Alex resources. Done means a complete article explaining how to create effective technical writing, including readability and neutral-language guidance; the issue does not identify a target file or entry point.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100