Eight Types of Technical Documentation Every Product Team Should Know

·1 views

Technical documentation spans multiple formats, each serving a distinct audience — from end users to internal engineering teams and AI coding agents. User-facing documents such as getting-started guides, tutorials, how-to guides, API references, and troubleshooting pages help customers and developers adopt and operate a product. Process documents support the teams building and maintaining systems, while a newer category — agent instructions — provides coding agents with repository-specific context not suited for human-facing guides. Frameworks from organizations like Squarespace Engineering and ClickHelp classify documentation by reader behavior, goals, and experience level. Choosing the right document type depends on identifying who needs the information and what they are trying to accomplish.

Read the full story at DEV Community

This is an AI-generated summary. ShortSingh links to the original source for the complete article.

Discussion (0)

Developer Builds Filipino Recipe App That Suggests Dishes Based on Weather

A developer has created Lutong Simmer, a native Android app that recommends Filipino dishes by factoring in current weather conditions and time of day. For example, the app may suggest Sinigang on a rainy afternoon or Halo-Halo during hot weather. Built with Kotlin using an MVVM architecture, the app works offline through local Room SQLite storage, ensuring recipes remain accessible without an internet connection. It also features a 'Kitchen Studio' section where users can create, save, and track their own custom Filipino recipes with step-by-step checklists. The interface is designed with a Filipino cultural identity in mind, incorporating a terracotta-inspired color palette and localized greetings.

0 comments Read more at DEV Community

ProgrammingDEV Community ·

How Staff Engineers Solve Cache Stampede: The 40,000-Request Database Problem

A cache stampede, or 'thundering herd,' occurs when a popular cache key expires and thousands of simultaneous requests bypass the cache and hammer the database with identical queries. The core issue is duplication, not volume — during a 200ms cache rebuild window, thousands of requests each independently trigger the same database query. Engineers can address this using either a distributed lock, where only the first request rebuilds the cache while others wait, or a stale-while-revalidate strategy, which serves slightly outdated data instantly while refreshing in the background. The right choice depends on the product context — account balances demand fresh data via locking, while product listings can tolerate brief staleness. A further safeguard is adding random jitter to cache TTLs at write time, preventing mass simultaneous expiries when many keys are set together.

0 comments Read more at DEV Community

ProgrammingDEV Community ·

Wotchi Adds Lightweight Error Alerting to Express APIs Without Extra Dashboards

A developer has released Wotchi, an open-source, in-process alerting library for Node.js services built to reduce noisy error notifications in Express APIs. The tool sits as middleware between Express routes and the final error handler, normalizing, redacting sensitive data, and grouping repeated failures before dispatching alerts. Notifications can be sent to the console, a Telegram channel, or any HTTPS webhook, requiring no hosted observability platform or new account. Wotchi supports Node.js 18.18.0 and above, works with Express 4 and 5, and is compatible with ESM, CommonJS, and TypeScript. The library is currently in public beta at version 0.1.0-beta.6, meaning its API may still change before a stable release.

0 comments Read more at DEV Community

ProgrammingDEV Community ·

Studies Show AI Citation Patterns in SaaS Vary by Platform, Prompt, and Buyer Stage

Multiple research efforts examining how AI systems like ChatGPT select sources for B2B SaaS buyer queries are revealing consistent but nuanced patterns. Analyses linked to researcher Kevin Indig and a separate BeVisibleIQ study of 75 SaaS buyer prompts across four AI engines both indicate that citations tend to concentrate among a relatively small group of domains. The research also shows that which sources get cited — whether vendor websites or third-party content — shifts depending on the AI platform used and the buyer's stage in the decision journey. Experts caution that metrics like unique cited domains and citation volume measure different things, making cross-study comparisons unreliable if methodology differences are ignored. The findings collectively suggest that earning AI visibility is not as simple as publishing more content, but depends on the interplay of query context, platform, and source material.

0 comments Read more at DEV Community