DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Find the Salesforce fields, flows and validation rules only your senior can explain
juanma_garrido_1974 profile

Find the Salesforce fields, flows and validation rules only your senior can explain

#salesforce #python #documentation #career
Comments
3 min read
I Was the Only IT Person for 3 Years: The Documentation I Wish I'd Written
jronegit profile

I Was the Only IT Person for 3 Years: The Documentation I Wish I'd Written

#documentation #sysadmin #career #knowledgemanagement
1
Comments 2
8 min read
How to Write MCP Tool Descriptions That AI Agents Actually Understand
docstar_io profile

How to Write MCP Tool Descriptions That AI Agents Actually Understand

#mcp #ai #documentation #devtools
Comments
4 min read
Requirements Traceability Matrix (RTM): Template and Example
oleksandr_tytarenko profile

Requirements Traceability Matrix (RTM): Template and Example

#requirements #testing #documentation #softwareengineering
1
Comments
5 min read
ArchiMate® diagrams as code with Mermaid
berny0x profile

ArchiMate® diagrams as code with Mermaid

#mermaid #architecture #documentation #javascript
2
Comments 1
8 min read
A document we deleted in September is cited 73 times in our code, and the file explaining the citation convention is one of the citers
daniel_pertu profile

A document we deleted in September is cited 73 times in our code, and the file explaining the citation convention is one of the citers

#documentation #typescript #architecture #webdev
Comments 1
5 min read
Business Requirements Document (BRD) Template and Example
oleksandr_tytarenko profile

Business Requirements Document (BRD) Template and Example

#requirements #documentation #productmanagement #softwareengineering
1
Comments
5 min read
Should code comments link to Stack Overflow answers? Let's argue about it
linkbruno profile

Should code comments link to Stack Overflow answers? Let's argue about it

#discuss #programming #documentation #webdev
Comments 1
5 min read
Property Operations Search: Freshness Windows for Cited Engineering Documentation
matsjohansson6547 profile

Property Operations Search: Freshness Windows for Cited Engineering Documentation

#rag #semanticsearch #python #documentation
Comments
4 min read
How to Turn Your API into an MCP Server Without Writing Server Code
docstar_io profile

How to Turn Your API into an MCP Server Without Writing Server Code

#mcp #api #ai #documentation
Comments
5 min read
Your Docs Are Now an AI Agent's Toolkit: Meet DocStar MCP Servers
docstar_io profile

Your Docs Are Now an AI Agent's Toolkit: Meet DocStar MCP Servers

#mcp #ai #api #documentation
Comments
4 min read
The History of 'Architecture Decision Record' | 架构决策单(ADR)发展史
cognitalk profile

The History of 'Architecture Decision Record' | 架构决策单(ADR)发展史

#architecture #documentation #softwareengineering
Comments
5 min read
Editing numbered steps so readers never lose their place
nataliakovac profile

Editing numbered steps so readers never lose their place

#documentation #technicalwriting #writing #beginners
Comments 1
3 min read
How to Keep Your API Docs in Sync with Your Code (and Stop Docs Drift)
docstar_io profile

How to Keep Your API Docs in Sync with Your Code (and Stop Docs Drift)

#api #github #documentation #devtools
Comments 1
4 min read
Part 4: I wrote the page developers read when something breaks, and set up a Jira board to track it all.
joycefosterr profile

Part 4: I wrote the page developers read when something breaks, and set up a Jira board to track it all.

#github #documentation #troyal #opensource
4
Comments 2
1 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.