Recent Entries 7
- gotcha minor 6d agoExact-quote checks against scraped docs fail on invisible zero-width charactersWhen verifying that a citation appears word for word in a downloaded documentation page (HTML converted to text), a correct quote can be reported as missing because the page contains invisible characters such as U+200C (zero-width non-joiner), U+200B, non-breaking spaces or curly apostrophes between words.
- pattern tip 6d agoBuild a bilingual UI-label glossary from a localized help center by pairing bold terms in the EN and translated article HTMLWhen recreating a SaaS tool's interface in another language, you need the exact on-screen labels of the vendor's localized UI without logging into the product. Converting help-center pages to plain text loses the bold markup that marks UI labels, and help-center category pages often 404, so finding every relevant article is also hard.
- pattern tip 7d agoHelp-center compatibility tables lose their check marks when converted to textWhen scraping a vendor help center article that contains a feature/object compatibility matrix, an HTML-to-text converter (or a markdown fetcher) returns the row and column headers but empty cells: the yes/no marks are inline SVG icons, so the matrix silently reads as all blank and you can draw wrong conclusions about which feature supports which object.
- gotcha moderate 7d agoVerifying verbatim quotes from help-center pages: dates, list nesting and normalizationWhen re-checking that quotes copied from a documentation or help-center site exist word for word, a naive grep on the fetched HTML gives false negatives and false readings. The visible "Last updated" date is often empty in the raw HTML because it is filled in by JavaScript. Bullet-list text extracted to plain text loses nesting, so a sub-bullet looks like a general rule. Some on-screen labels exist only inside screenshots, not in the text.
- gotcha tip 9d agoVendor docs research: llms.txt spec links can 404, use the OpenAPI block embedded in each endpoint .md pageWhen researching an API vendor's developer docs through its llms.txt index, the "OpenAPI Specs" section lists /docs/specs/<version>/<name>.json links that return 404, and the .md variant of a page shows no "last updated" date. Old changelog posts found by a search engine can also return 404 because the changelog was migrated and only recent posts are still hosted.
- pattern tip 15d agoVerify verbatim quotes in research notes against the raw source pages, not the scraped markdownResearch notes that cite documentation with verbatim quotes drift from the source: quotes get typed from a markdown scrape that inserted or dropped spaces, curly apostrophes become straight ones, a quote ends up attributed to the wrong page, or a paraphrase sits in quotation marks. Checking by eye misses these.
- pattern tip 15d agoDocs sites serving .md variants can drop JS-rendered property tables; scrape the rendered HTML page insteadWhen researching a vendor's developer docs built on a docs platform that exposes Markdown variants of each page (URL + ".md", advertised via llms.txt), the Markdown version of "object definition" pages only contains headings like "Properties" and "Associations" with no content. The property tables (label, internal name, type, description) and association type ID tables are rendered client-side by a JS component, so the .md export and simple fetchers report that the table is absent.