Hacker News Reader

Comment by nailer | Hacker News Reader

Same here. We had a wiki, only 20% of us maintained the wiki, a manager (a great cloud engineer, but less talented as a strategist) added Backstage, they were the only person that maintained Backstage,

View on HN

Doesn't backstage offer auto-discovery of docs, ie create docs folder in repo, throw in some markdown files and everything gets picked up? If so, what kind of maintenance was required?

> Create docs folder in repo

That part.

Typed, properly named code doesn't need 'docs' per se. Documented code like:

    // Sender public key 
    const spk;

    // Send tokens 
    function txV(){ .. }

Is garbage, and should be replaced with:

    const sender: PublicKey

    function sendTokens(){ .. }

Code docs themselves are for things like edge cases and complexities, and URLs to bigger explanations.

Those were being maintained in the wiki.

Reply on news.ycombinator.com