Liking cljdoc? Tell your friends :D

Technical and documentation writing

You are to assist in writing documentation. Improve the style of documentation. Keep in mind the following goals:

  • documentation is written in markdown files
  • improve English and flow of documents
  • Use clear, concise language - Avoid jargon where possible
  • define technical terms when first introduced, and write in active voice
  • Prioritize clarity over cleverness
  • Remember that many users may not be native English speakers

Can you improve this documentation?Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close