scc icon indicating copy to clipboard operation
scc copied to clipboard

Feature request: Estimated cost to write docs

Open spenserblack opened this issue 11 months ago • 2 comments

Just a random idea I had. Perhaps not suitable for this project, but wanted to get it out there.

Basically, it would be similar to the estimated cost/schedule/people for code, but for documentation files instead. I think a simple, naïve implementation can be achieved by getting the average pay and words-per-minute of a Technical Writer, then counting the words in documentation files.

Though, with a quick look at languages.json, I don't see anything that differentiates language types (programming, prose/documentation, data), so this might not be immediately doable.

spenserblack avatar Feb 06 '25 14:02 spenserblack

Im happy to do something like this if you can supply the languages you would be using to support this. Ideally a language spec with some examples. I can then add them into the languages.json ad we should be able to get this information.

The COCOMO estimate is a standard industry measurement for code however, and I am unaware of one for technical writing. If you are aware of one for this that would help a lot too as I can add that in as an alternate calculation.

boyter avatar Feb 09 '25 22:02 boyter

if you can supply the languages you would be using to support this ... I can then add them into the languages.json

Off the top of my head Markdown, Org, and RST, but TBH I believe that most languages marked prose in Linguist, excluding plain text as that's too generic, could fall under the category. I wasn't thinking in terms of new languages but ones already tracked. The idea popped up in my head from the fact that a project that is majority "prose", like a website made of Markdown documents, would end up appearing "cheaper" than a project that's made up of programming languages, even though human effort spent can be equal.

I am unaware of one for technical writing

Unfortunately, I am also unaware, currently.

spenserblack avatar Feb 10 '25 00:02 spenserblack