Recent posts tagged documentation

Level UI • 1 day • in Articles • 9 min read
Somewhere in the last year, "do we need an MCP server?" joined the list of questions that arrive in a brief before anyone has said what the thing is for. It is usually framed as MCP vs API, as though the Model Context Protocol were a newer kind of AP...
post-cover-33074
  • ai
  • api
  • webdev
  • security
Intellodocs • 1 day • in Articles • 7 min read
Every office has the same quiet problem. A client sends a contract on WhatsApp, someone downloads it, and the same file arrives again by email the next morning. A colleague then saves a "final" copy to their desktop. Within a week, one document has b...
post-cover-33057
  • documentation
  • software-engineering
Ken W. Algerverified • 3 days • in Articles • 12 min read
The gap between publishing a correction and seeing it reflected in an AI-generated answer is becoming a problem that traditional SEO metrics cannot fully explain. A website owner updates an important page. The new version fixes a technical error, cl...
post-cover-32573
  • ai
  • seo
  • webdev
  • documentation
uglypeardata • Oct 18 • in Articles • 6 min read
If you run document search or retrieval-augmented workflows inside a regulated institution, you are balancing three forces that pull in different directions: the need to keep data inside your own perimeter, the need to control what each role can se...
post-cover-31676
  • documentation
  • compress
Intellodocs • Oct 16 • in Articles • 6 min read
AI tools that answer questions from your documents sound great on paper. You type a question, and in two seconds you get a clean answer. No scrolling through forty PDFs. No asking a colleague to resend something. But here is the question nobody asks...
post-cover-31489
  • automation
  • documentation
lisarconnect • Oct 15 • in Articles • 5 min read
This checklist shows how to review people, devices, profile revisions and pending setup records using existing approved sources. Each unresolved item should end with an owner and a next action. Adapted with permission from A Periodic VPN Access Revi...
post-cover-31179
  • vpn
  • networking
  • documentation
lisarconnect • Oct 14 • in Articles • 5 min read
This guide sets out a small naming convention for issued VPN profiles. It covers readable assignment labels, revision suffixes, matching client names, and what to keep out of filenames. Adapted with permission from A Practical VPN Profile Naming Con...
post-cover-31028
  • vpn
  • networking
  • documentation
Alexis Kypridemos • Oct 7 • in Articles • 2 min read
In a previous posthttps://dev.to/alexiskypridemos/changelog-vs-narrative-documentation-a-real-world-test-1kck, I tested a changelog-driven approach to documentation using a real open source project, the Trongate PHP frameworkhttps://trongate.io. The...
  • documentation
  • readme
  • changelog
  • trongate
Intellodocs • Sep 21 • in Articles • 7 min read
Every Indian business — whether a chartered accountant's office in Karnal, a law firm in Mumbai, or a manufacturing company in Pune — eventually hits the same wall: documents pile up faster than anyone can organize them. Invoices land in email, contr...
post-cover-27906
  • documentation
lisarconnect • Sep 21 • in Articles • 3 min read
When a VPN rollout reaches a company laptop, the first dependency is often a policy decision. The person using the device may not be allowed to install a client, add a profile, import a certificate, or change network settings. A useful preflight make...
post-cover-27902
  • vpn
  • networking
  • documentation
Tom Smithverified • 20 hours • in Articles • 9 min read
Security dominated this week, but not in the usual way. Two active campaigns turned GitHub configuration files into attack surfaces. Researchers demonstrated that the built-in browsers inside AI coding tools can read your SSH keys. And at Oracle AI ...
post-cover-33104
  • agenticai
  • devsecops
  • github
  • localai
ExperiencingBriefTechnicalSuperiority • Sep 17 • in Articles • 5 min read
Developers have a strange relationship with documentation. We love well-documented libraries. We appreciate clear APIs, useful examples, configuration references, migration notes, architecture diagrams, and a README that tells us what we actually n...
post-cover-27518
  • documentation
  • collaboration
  • codequality
Hanzla • Jul 24 • in Articles • 14 min read
The Slack message drops like a lead balloon: "Hey, has anyone heard from Alex? They haven't responded to emails or pulled requests all week." A collective shiver runs through the team. Alex, the unsung hero who single-handedly tamed the notorious Leg...
  • software-engineering
  • bus-factor
  • documentation
  • observability
Alexis Kypridemos • Jun 29 • in Articles • 1 min read
In a previous posthttps://dev.to/alexiskypridemos/structuring-technical-documentation-by-date-5h0k, I advocated for a date-based documentation approach. I later realized this already has a name: a changeloghttps://keepachangelog.com. I shared the id...
  • documentation
  • readme
  • changelog
  • trongate
bilalmlkdev • Jun 18 • in Discussions • 1 min read forumDiscussion group3 participants
  • discussion
  • documentation
  • developer
  • coding
Posted in WebDev group
SnappyTools • May 30 • in Tutorials • 3 min read
Markdown is the closest thing to a universal documentation format. READMEs, wikis, blog posts, technical documentation — Markdown is the default choice. Here's a comprehensive reference for syntax, extensions, and conversion. Core syntax quick refer...
  • webdev
  • tools
  • documentation
catssaymeow • May 14 • in Articles • 1 min read
!Markdown Editorhttps://coderlegion.com/?qa=blob&qablobid=12847191464559850342 As someone who writes docs and takes notes frequently, I believe Markdown is one of the best ways to display documents, especially complex ones, and writing Markdown is a...
  • markdown
  • devtools
  • tooling
  • documentation
Posted in AI group
DevFuture • May 9 • in Articles • 1 min read
The Problem Most teams have their client data well-structured — in HubSpot, Airtable, or Google Sheets. But when it’s time to send a proposal, contract, or invoice, someone still opens Word and starts copy-pasting. This is one of those workflow ga...
post-cover-17165
  • webdev
  • ai
  • documentation
  • automation
Ezejah Chimkamma • May 2 • in Articles • 1 min read
A product can work perfectly… And still feel unreliable. I’ve seen this happen more times than people realize. No bugs. No crashes. No major issues. But users hesitate. They second-guess. They get stuck. They don’t move forward with confidence. ...
  • dev
  • saas
  • ux
  • documentation
Ezejah Chimkamma • Apr 28 • in Articles • 1 min read
I’ve noticed a pattern across a lot of products. The product works. The team is capable. The idea is solid. But adoption is slow. And most founders think: “We just need more features.” “We need better marketing.” But that’s usually not the probl...
  • developerexperience
  • documentation
  • saas
  • founders
DevFuture • Apr 22 • in Launches • 1 min read
Document...
  • documentation
  • document
  • automation
chevron_left
🔥 27 posts • 👩‍💻 16 active writers

✨ Want to write in this topic?
Share your learning. Get discovered. Build your profile.
Join CoderLegion

💡 Why developers use CoderLegion
Track learning • Share posts • Get ranked publicly
Create your profile