Technical Writing Skill

Core Principle

Write for your audience, not for yourself.

Technical documentation exists to help others understand and use your work. Good documentation:

• Answers questions before they're asked
• Shows, doesn't just tell (examples over abstract descriptions)
• Stays current (outdated docs are worse than no docs)
• Is findable (organized and searchable)

Documentation Types

1. README Files

Purpose: First impression and quick-start guide