Click any tag below to further narrow down your results
Links
This is a GitHub project that teaches Claude (or other LLMs) to write in Simplified Technical English (STE), a controlled language used by aerospace and defense industries for clear, translatable technical documentation. It includes writing rules, an approved word list, and a Python checker tool to validate compliance.
- The skill enforces 53 writing rules and a dictionary of 869 approved words based on the official ASD-STE100 specification, making technical text shorter and easier to translate
- It includes a Python validation tool that catches common violations like overly long sentences, unapproved verbs, passive voice, and words outside the approved list
- The tool has real limitations—it can't verify if words are used with their approved meanings, and a human expert still needs to review critical documents for full specification compliance
Nolan Lawson explores why developers often build custom solutions instead of using built-in browser and platform capabilities, tracing the reasons from historical browser gaps to the genuine appeal of building things yourself. He argues that understanding this skepticism matters more than simply repeating "use the platform" as advice.
- Developers prefer custom solutions partly from habit and familiarity with npm ecosystems, but also because building things yourself is genuinely more engaging and educational than reaching for a ready-made API.
- Poor documentation and scattered resources historically made it easier to find and use third-party libraries than to discover what the platform could already do, though this has improved with MDN and web.dev.
- Most "avoid the platform" behavior stems from incomplete knowledge of how the underlying system works—developers build custom solutions not out of laziness but because they don't fully understand what the platform offers, a pattern that applies across all development domains, not just the web.
As AI agents generate more code from prompts, the actual intent behind that code gets lost. The author argues teams should treat Markdown specifications as source code, checking them into `/src` alongside generated code so both humans and agents can reference the same source of truth.
- Today's AI-generated code emerges from ephemeral prompt sessions with no persisted specification, unlike traditional compilers that retain source code. Markdown in the codebase should become the canonical specification instead.
- Markdown belongs in `/src` next to code because it keeps intent and implementation together, eliminates scattered documentation across wikis and tickets, and works naturally for both human and agent consumption.
- Tests shouldn't be the specification—they're too ceremonial and low-level for humans to work with effectively. Markdown specs and derived tests should have separate roles.
This is a placeholder domain reserved by IANA for use in examples and documentation. It's not meant for actual operations or real-world use.
- Example.com is designated specifically for documentation and educational examples
- Using it in production systems or operations is discouraged
dbt-doctor scans dbt projects for maintainability issues like missing documentation, weak test coverage, schema drift risks, and DAG problems. It generates a health score (0–100) and can run locally, in pre-commit hooks, or as a GitHub Actions quality gate.
- Detects 122 rules across 9 categories including missing docs/tests, stale models, naming convention violations, and governance gaps
- Integrates into CI/CD with GitHub Actions, outputs sticky PR comments, and can fail builds based on error/warning thresholds
- Configurable via presets (default/strict/enterprise), inline suppressions, and .dbt-doctor config file; respects .gitignore and .sqlfluff rules
Claire Gouze lays out a practical process to build and test a context layer your data agents can trust. She shows how to start small with dbt docs and markdown files, write evals, clean up data models, and iterate until you reach around 90% reliability.
- Adding query logs and profiling alone got the agent stuck around 40% accuracy; reworking the data model and documentation pushed it to 90%.
- Treat context like code: store it in files/markdown, version in Git, add CI/CD evals, and iterate on failure cases rather than plugging agents directly into raw databases.
- Start small—10 to 20 core tables with existing dbt docs—rather than trying to cover the whole warehouse at once.
- Evals should come from real BI query history or autogenerated question sets, reviewed by teams and tracked over time to build trust in the agent.
The article argues that rigid folder hierarchies no longer match how people or AI find information. It shows users forage for clues and AI retrieves by meaning, not location, and recommends multiple discovery paths—search, metadata, links and tags—to build a connected knowledge graph.
- Folder hierarchies force single "right" locations for info that actually spans multiple teams/contexts (e.g., a component accessibility decision touching design, engineering, content, support)
- AI retrieval tools already surface content by meaning/keywords rather than folder path, proving folders organize storage, not knowledge
- People actually find info by foraging—searching, skimming a couple nav levels, then asking a colleague—not by drilling through directory trees
- The fix is layering multiple discovery paths (search, tags, metadata, cross-links) to build a connected knowledge graph, mirroring tools like Obsidian's graph view and accessibility's "never rely on one cue" principle
@zeldapoem on X
This is a short X post from @zeldapoem, not an article, and it simply expresses delight that someone wrote about lab notebooks. It contains no substantive argument, data, or named tools to analyze.
- The post is a brief reaction ("Pinch me, I can't believe someone wrote about lab notebooks") rather than an article with claims.
- It names no specific people, products, studies, or findings beyond the general subject of lab notebooks.
Mintlify integrates AI into every stage of documentation, from drafting and editing with a context-aware agent to guided user conversations via an AI assistant. It supports standards like llms.txt and MCP, offers enterprise-grade migration services, and meets SOC 2 requirements with SAML-based SSO.
- Mintlify supports llms.txt and MCP so products can plug directly into AI workflows, and uses a context-aware agent to draft/edit docs and reduce "documentation debt"
- An embedded Assistant turns doc visits into guided chats that surface relevant sections and examples instead of relying on plain search
- It offers white-glove migration, SOC 2 compliance, and SAML-based SSO, with ISO 27001 and GDPR certifications still in progress
- Used by both early-stage AI startups and established consumer brands, pitched as a fast, low-maintenance alternative to building custom docs infrastructure
Career advancement in software development often leads to a choice between management and architecture tracks. While management focuses on people and processes, the architect role emphasizes coding and effective communication of ideas, requiring strong documentation skills to facilitate collaboration. This article provides insights on writing effective documents to enhance communication and influence within teams.
- Career growth in software eventually forks into a management track (people/process) or an architect track (technical depth + influence without authority)
- Architects rely on documents as their primary tool for driving decisions, since they lack managerial authority to mandate outcomes
- Effective architecture documents must clearly communicate ideas, tradeoffs, and reasoning to persuade and align teams, not just record technical specs
The content of the article is not accessible due to encoding issues, resulting in garbled text that makes it impossible to extract meaningful information. Further investigation or a different version of the article is necessary to provide a summary.
- The article content could not be retrieved due to text encoding errors that corrupted the original text.
- No factual claims, data, or findings could be extracted from the source material as provided.