Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Estimated cost to write docs #583

Open
spenserblack opened this issue Feb 6, 2025 · 2 comments
Open

Feature request: Estimated cost to write docs #583

spenserblack opened this issue Feb 6, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@spenserblack
Copy link
Contributor

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.

@boyter
Copy link
Owner

boyter commented Feb 9, 2025

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.

@spenserblack
Copy link
Contributor Author

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.

@boyter boyter added the enhancement New feature or request label Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants