SShortSingh.
Back to feed

New Workflow Separates AI-Generated API Docs from Human-Owned Commitments

0
·1 views

A proposed documentation workflow splits API reference content into two distinct lanes: 'compile' lanes, where AI models restate facts already verified in a repository, and 'signature' lanes, reserved for human-authored commitments such as deprecation timelines, support terms, and security guarantees. The core problem it addresses is that mixing both types in a single AI-generated draft hides unverified promises inside text that reviewers may assume is factually checked. A decision table maps every documentation block type to its lane, allowed inputs, and a strict merge rule that fails if content is untagged or misclassified. A classifier tool runs before merge to enforce these rules, rejecting any signature-type statement that lacks a named human owner. The workflow treats the lane decision table as a formal policy document, meaning changes to it require the same review process as changes to an OpenAPI specification.

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)

Log in to join the discussion and vote.

Log in

Related stories

0
ProgrammingDEV Community ·

Freelancer loses long-term client to AI, learns which work is truly irreplaceable

A freelancer lost a client of over a year not due to poor performance, but because the client chose to replace routine tasks with an AI tool at a lower cost. The writer reflects that the work lost was simple, repetitive, and required little creative judgment — making it an easy target for automation. The experience revealed that predictable, low-effort work carries the highest risk of being displaced by AI tools. Clients who continued working with the freelancer were those who needed complex, judgment-driven problem-solving that AI cannot reliably handle. The writer now uses this as a lens to reconsider how freelancers should position their skills in an AI-augmented market.

0
ProgrammingDEV Community ·

How barometer.today builds its animated global isobar maps using open weather data

Barometer.today, a web tool showing air pressure forecasts for cities worldwide, also features an animated global isobar map spanning one day back to four days ahead. The map is generated from ECMWF forecast data sourced via Open-Meteo, delivered as a pressure grid at 0.25-degree resolution and updated four times daily. To prevent jagged contour lines, the team applies a Gaussian blur, but uses a normalized convolution technique to stop inflated sea-level pressure values over high plateaus — such as the Himalayas and the Andes — from distorting surrounding data. Elevated terrain above 2,500 metres is masked using a digital elevation model, and isobars crossing these regions are rendered as dashed lines rather than omitted, keeping the map visually continuous while signalling extrapolated values. The underlying code is written in Python using numpy, scipy, contourpy, and shapely, and the approach is applicable to anyone drawing contour maps from gridded geospatial data.

0
ProgrammingHacker News ·

CIA Declassifies 71 President's Daily Briefs Tied to 9/11 Anniversary

The CIA has released 71 declassified President's Daily Brief documents related to the September 11 attacks. The release was made in commemoration of the 25th anniversary of 9/11. President's Daily Briefs are highly classified intelligence summaries prepared for the sitting U.S. president. The declassification provides the public with a rare look at the intelligence landscape surrounding the 2001 terrorist attacks. The documents are available through the CIA's official website.

0
ProgrammingGitHub Blog ·

GitHub Engineer Automates APAC Marketing Event Ops Using Code-Based Workflows

A GitHub engineer developed an automation system to streamline the full lifecycle of marketing events for the company's Asia-Pacific team. The approach is built on the principle that any documented, repeatable workflow can be automated. The system covers event operations from initial planning through to post-event follow-up. By treating marketing processes as code, the solution reduces manual effort and improves consistency across campaigns. The project was shared via the official GitHub Blog as a practical example of applying engineering thinking to marketing operations.

New Workflow Separates AI-Generated API Docs from Human-Owned Commitments · ShortSingh