• Appoxo@lemmy.dbzer0.com
    link
    fedilink
    arrow-up
    2
    ·
    edit-2
    1 day ago

    How about this:
    Humans (or humans assisted by AI) write documentation
    Users (devs included) can either choose to read the manual the old fashioned way or utilize it like a sort of swagger api documentation to give

    1. Information to a question (How to do x)
    2. Provide a general example
    3. (Assuming it’s used with an IDE or has information about the project) Provide a personalized example on the implementation.