Page MenuHomePhabricator

Add screenshots in the documentation
Closed, DeclinedPublic

Event Timeline

Framawiki renamed this task from Add screenshot in the documentation to Add screenshots in the documentation.Nov 3 2017, 12:17 PM
Framawiki created this task.
Framawiki added a project: Google-Code-in-2017.

I purpose to mentor this task for Google-Code-in-2017.

Hmm, screenshots for a console application where the (copyable) console output seems to be pasted as text already? Is this really reasonable? :)

Aklapper changed the task status from Open to Stalled.Nov 27 2017, 9:28 PM
Aklapper subscribed.

In my opinion text should be text (so it can be indexed by search engines), and images should only be added if they really provide additional informative value (as they create maintenance costs whenever they need updates because something has changed).

@Framawiki: So this task lacks information which screenshots you are missing for which situations (and how they help, compared to some existing text). Could you provide that? :)

For the records, on mediawiki.org there exists a template to make stuff look like a terminal/commandline window. Wikitext example:

{{terminal|title=This is an example:|text=
some line!
another line?
}}

PAWS was designed for non-developers, so having a some screenshots of the entire web page, not only a copy/pasted text that they should see, can, IMO, be interesting for readers.
I'll give myself some time to think about this task again.

Screenshots of specific UI elements / complex areas can sometimes help understanding text better. I don't see how screenshot of a complete web page help with anything per se, plus they make maintenance of translated documentation way harder. We don't want screenshots to have screenshots, we want screenshots to support understanding a good help text. :)