The best measure of how good your internal documentation is, comes down to how easy it is to understand at three in the morning, mid-task, for someone looking at these instructions for the first time. If the person creating this documentation has done a good job, the things they assumed to be well known to everyone will be clear to the person reading this, no matter how much time has passed and how new they are to this documentation. This gap is what we try to fill.
We interview your engineers, look back at the actual history of the on-call rotation, and document what people carry in their heads. The dashboards that matter, the service whose name no longer describes its function, the manual step that someone failed to automate.
Findability first, then sequence. Engineering searches will click the search button before navigating to the next page of your site. Information on these pages needs to be an answer for the engineer’s question. The first screen must be the answer, not the background. After that it is ordinary craft: numbered steps, exact commands, and the expected output beside each one.
There is nothing about internal documentation that is publicly available. A model does not know your naming conventions, which of your four dashboards people actually open, nor does it know that billing-v2 was retired last year and billing-v1 is still running. It writes a plausible runbook for a fictional company.
The writer prefers to follow the process themselves versus reading about it. With a runbook, that would mean shadowing someone and describing the steps they took to resolve the last incident, while also noting steps they failed to verbalize. The impetus for that structure is usually the flow that people actually follow as opposed to the flow documented in the design.
Internal documents expire quicker than anything else because people outside the team don’t check them. Each document is assigned an owner, and each record has the last verified date. Each page has to be short enough to be quick to update, as well as showing current page dependencies. Large documents are not updated.
One rate, whatever the format: $10 per 100 words. You are paying for the writer’s time and judgement, so the price scales with the words rather than with a package tier.
| Typical engineering documentation | Words | Writing | Fee (1%) | You pay |
|---|---|---|---|---|
| Short | 500 | $50 | $0.50 | $50.50 |
| Standard | 1,000 | $100 | $1 | $101 |
| In-depth | 2,000 | $200 | $2 | $202 |
The writer receives 100% of the writing price. Our 1% fee is added on top of it, and 0.5% is donated to tree planting. Full pricing breakdown.
We match the brief to a writer who has already worked in that subject area. If you have worked with an Articled writer before and want them again, name them and we will check their availability first.
Fill in the order form with your brief and email address. No account needed. You get a confirmation by email, then the finished piece as a document within 3 days.
We use Markdown and Confluence markups to upload files for you to publish. This process keeps access controls in the correct position. It is a simple process if we make you a temporary writer account, but we can do that under a non-disclosure agreement.
By allowing them to book time and asking the questions a newcomer would. Most of a good runbook is from the asides that they add without thinking. Construction on the runbook is complete. To capture what is still missing, the writer reads the finalization draft to them.
Completely. Copyright transfers to you on delivery, with no attribution requirement and no licence back to us. Nothing written for you is resold, repurposed or republished.
Reviews from completed, paid orders in this category.
I sent a folder of interface screenshots and asked for callout text. Every caption matches what is actually visible in the image. Sounds basic. I have paid three other people for this and had to correct half the captions each time.
I asked the guide to be assembled in a way that a frustrated customer would think. It was harder than I expected, but it came back perfectly with the answer that half of the customers try - rebooting - placed at the begining.
We have never recorded our three architecture talks but we have now. One of the teams who take note of things and join in a session and then compile a summary of the two positions once we’ve made our decision. Saw that as a good opportunity to strengthen their practice so no longer have any new hires asking questions. Parent 1: rewr22567 Parent 2: autograder
We do not ask you to take the no-AI promise on trust. Each draft is run through these platforms and the reports are attached to your delivery email.
Originality.aiAI detection + plagiarism
GPTZeroAI detection
TurnitinAI detection + similarity
CopyleaksAI detection + plagiarism
Winston AIAI detection
ZeroGPTAI detection
SaplingAI detection
Content at ScaleAI detection
Send the brief, get a human draft back within 3 days. No account, no subscription, no AI.
$10 per 100 words · all of it to the writer · 0.5% to trees