Aman Mittal • 1/13/2025

Docs without please

Read Original

This article advocates for removing politeness markers such as 'please' and 'thank you' from technical documentation. It argues that these conversational artifacts add ambiguity, weaken critical instructions, and distract from the core purpose of docs: providing clear, direct, and actionable steps for users to accomplish tasks efficiently.

0 comments
#software development #communication #technical writing
Docs without please

Comments

No comments yet

Be the first to share your thoughts!

Browser Extension

Get instant access to AllDevBlogs from your browser

Top of the Week

1
The Beautiful Web
Jens Oliver Meiert • 2 votes
2
When your coding agent doesn’t understand your project, you’ll get junk
Benjamin Cane • 1 votes
3
LLM Use in the Python Source Code
Miguel Grinberg • 1 votes
4
Wagon’s algorithm in Python
John D. Cook • 1 votes
5
An example conversation with Claude Code
Dumm Zeuch • 1 votes