#documentation

The article presents a fictional manual for paperclips, exploring their history, manufacturing processes, and various uses. It examines paperclip design evolution and their cultural significance as everyday office objects.

The article discusses principles for creating beautiful documentation, emphasizing clarity, readability, and user experience. It explores how thoughtful design, organization, and presentation can make technical documentation more effective and accessible for users.

Google has launched Design.md, a documentation framework for design systems. The tool helps teams create and maintain consistent design documentation using Markdown. It aims to improve collaboration between designers and developers.

Cppreference.com has completed its migration and is no longer in read-only mode. The site is now fully operational with editing capabilities restored.

A text adventure game has been created entirely using Markdown formatting. The game demonstrates how Markdown can be used to build interactive narrative experiences through simple text-based elements.

The article discusses ACXD, providing information about this topic through various references and sources. It presents factual details without offering opinions or analysis on the subject matter.

OMGfixMD is a tool that allows users to comment on Markdown files as if they were documents, enabling collaborative feedback and editing directly within the Markdown format.

A command-line interface provides access to a knowledge base containing project conventions and standards.

Accept is a tool that allows users to input and process text in Markdown format. The platform provides functionality for working with Markdown documents and content.

The article discusses key elements that make documentation beautiful, including clear structure, visual design, and user-focused content. It emphasizes that effective documentation combines aesthetics with functionality to enhance user experience and comprehension.

The author describes adding a 'held' status to a Django web application for account requests, then realizing it was more restrictive than intended. This experience highlighted the need to document form behaviors, as past knowledge about form rules wasn't retained over time.

Python docstrings are attached to functions and scattered throughout code, making them local documentation. They work well for summarizing individual functions but poorly for providing overviews or documenting complex interactions between components.

The author discovered that using argparse argument groups to organize command-line options makes help output more readable. They realized they should use this feature more often in their Python programs with many options, as groups can logically separate important from obscure options.

The article discusses how the discovery phase encompasses the entire development process, suggesting that traditional project phases may be less relevant. It presents this perspective through a metaphorical reference to documents from a "Department of Best Practices."

The article discusses how relying solely on human memory for knowledge is risky due to forgetfulness and the "bus factor" problem. It emphasizes creating systems to document information, allowing humans to focus on creative problem-solving while computers handle remembering. Effective systems should clearly show priorities, capture all incoming tasks quickly, and be always available.

The author argues that examples are the most effective form of documentation for developers, noting that 95% of the time a single example would suffice but is often unavailable. They critique formal technical documentation as being too complex for developers who juggle multiple technologies, using Python's max function documentation as an example of overly technical explanations.

The article outlines 17 rules for writing effective software tutorials, addressing common flaws like missing key details and hidden assumptions. It emphasizes writing for beginners, promising clear outcomes, and providing practical guidance like making code snippets copy-pasteable.

The author, a developer with 20 years of experience, emphasizes the importance of clear writing in software development. They prioritize updating onboarding documentation and encourage teammates to document their learnings, despite questions from other developers about focusing on this "soft skill."

The author describes their journey to becoming the second-most prolific contributor to Docs.rs, a documentation hosting service for Rust crates. They explain their contributions to the platform's development and maintenance over time.

The article describes the author's involvement in stabilizing intra-doc links in Rust documentation. It details the technical challenges and collaborative efforts required to make this feature reliable for Rust developers.

The author shares a realization about code comment formatting practices, specifically regarding line wrapping techniques for comments in programming.

The author discovered FreeBSD in 2002 after using Linux, finding its comprehensive documentation and system stability impressive. They experienced better performance and reliability than Linux, particularly for servers and serious workloads. FreeBSD's philosophy of evolution over revolution and its dedicated community have maintained their engagement for decades.

The article provides guidance on creating effective design documents, outlining key components and best practices for clear technical communication. It emphasizes structuring documents to facilitate understanding and decision-making among stakeholders.

The article argues that chat interfaces are a poor UI pattern for development tools because they lack the precision needed for serious software development. It contends that programming requires document-like precision rather than conversational guesswork, and that successful software tools must enable clear specification and organization of complex systems.

The author describes a collaborative documentation technique where complex spec changes are first written out in a markdown file to ensure mutual understanding. This approach helps bridge knowledge gaps between team members by documenting problems, solutions, and reasoning before implementing changes.

The Redis documentation provides comprehensive information about commands, data types, common patterns, configuration hints, and algorithms that can be implemented using Redis. The resource is available at redis.antirez.com and is useful for both LLMs/coding agents and human developers.

MDV是一个Markdown超集，专为文档、仪表板和幻灯片设计，支持数据集成和交互式可视化。它扩展了标准Markdown语法，允许开发者直接在文档中嵌入动态数据源和可视化组件，提升技术文档和演示的交互性与实用性。