REDDIT 原始帖子

Best way for user manual generation

Hey guys, I was trying to make a user manual document for my web page for a client. What is the best way to make it ? In the past I always make a screenshot on each page, edit on photoshop/paint, and describe it one by one the functionality of each…

原帖正文r/webdev

Hey guys, I was trying to make a user manual document for my web page for a client. What is the best way to make it ? In the past I always make a screenshot on each page, edit on photoshop/paint, and describe it one by one the functionality of each button/input using microsoft word. Is there a extension/app to automate the screenshot of a user/admin flow? so I can edit the pdf on adobe/foxit/word later after taking a user flows/steps? Thanks

已收录讨论

5 条评论

u/webdev-ModTeam

Read and follow reddiquette; no excessive self-promotion. Please refer to the Reddit 9:1 rule when considering posting self promoting materials.

u/Manish_S_

i’d skip the manual screenshot grind and use playwright or cypress to walk the flow, then stitch the screenshots into a doc. i’ve had better luck keeping the manual in markdown first, then exporting to pdf after the client signs off on the wording.

u/erroronline1

i have semiautomated this for a web-application that never leaves the index.html. the screenshot-script iterates over the defined api calls and displays the screenshot-command with filename in the console to copy/paste for a preset 10 seconds per view. the whole process takes about 5 minutes for all 70ish pictures if i don't narrow it down. afterwards i can postprocess the files with a python script to resize them. still a chore but way quicker than before.

u/Vivid_Pudding5791

Yeah same way for me. Screenshots on each page and functionalities and I hated that workflow. Updating manual when there were changes on UI became quickly really tedious. Also looking solution for more automatic approach without any manual screenshots.

u/[deleted]

这条评论已被删除。