23965 shaares
32 results
tagged
documentation
Step-by-step for responding to common security incidents. Aimed at non-techies.
These guides cover essential topics such as: project planning; research ethics from the perspectives of the fields of folklore, anthropology, ethnomusicology and museum studies; and intellectual property policies, law and use with special reference to the work of the World Intellectual Property Organization in Geneva, Switzerland. Other subjects include: interviewing tips and techniques, writing field notes and producing summaries and logs of recordings, participant permissions and release forms, and links to sites that will help you understand digital recording technologies
The Technology Transformation Services Handbook is an open, crowd-sourced, accessible, and living resource that aims to provide the information our team needs to do their work.
Jean Hollis-Weber provides guidance and examples to help authors make technical writing gender-neutral, clear and useful.
Guidelines and resources for web writers and editors. Includes: voice and tone, grammar, web style, social media, email newsletters, blog posts, legal content, technical content, accessibility, translation, copyright, and more.
18F’s Style guide for open source project documentation - GitHub - 18F/open-source-guide: 18F’s Style guide for open source project documentation
Patience and empathy are the basis of good documentation, much as they are the basis for being a decent person. Here's a how-to for creating better open source project docs, which can help your users and grow your community.
Good stuff for the how-to-train chapter.