Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Users Search
Help Dashboard Sign In Sign Up
Q&A Code Reviews Meta
Q&A
Posts Tags Edits
Ask Question

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Comments on Are there textual-formats for documenting actions in Graphical Windows systems?

Post

Are there textual-formats for documenting actions in Graphical Windows systems? [closed]

+1
−3

Closed as off topic by Alexei‭ on Apr 28, 2022 at 05:53

This question is not within the scope of Software Development.

This question was closed; new answers can no longer be added. Users with the reopen privilege may vote to reopen this question if it has been improved or closed incorrectly.

I've recently been involved with creating text documentation of steps for workflows in graphical windows systems (and web-pages). These are often somewhat wordy, for example: "Click on the 'Exit' item of the menu in the upper-left corner of the screen".

Are there more concise and established protocol/standards/formats for this type of text-based documentation that describes steps taken on graphical-windows?

documentation
posted over 3 years ago
2y ago
user card
CodeFarmer‭
54 reputation 4 1 7 15
History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.
Why should this post be closed?

2 comment threads

The question is borderline off-topic... but you might want to consider a format which can be used by ... (3 comments)
Wordy? (2 comments)
Wordy?
elgonzo‭ wrote over 3 years ago · edited over 3 years ago
copy link

I don't see anything wordy about "Click on the 'Exit' item in the upper-left menu." It's a simple and short sentence, following the structure "action on what where". Most words in this sentence are short, too (most of them just 4 letters or shorter). If that is too wordy for you and you are seeking to "compact" a sentence such as this, i am afraid you will have to start abbreviating 4-letter words... :-)

CodeFarmer‭ wrote over 3 years ago
copy link

Thanks!, Yes, you have a good point that the current way I'm writing text instructions for interfacing with Graphical Windows systems is reasonable particularly is kept to the discipline of "action on what where". I hesitated to ask this question because I had somewhat the same thought. However, sometimes a specification or format has been invented and some popularity but one doesn't know about it... So I thought I would ask just to check :-)