リクエスト広場

プラグインマニュアルの項目を見直してほしい / 16

22 コメント
views
16
WIKIWIKI運営 2025/09/21 (日) 18:40:54

ご指摘ありがとうございます。

マニュアルの整備や動線についてご不便をおかけして申し訳ありません。
プラグインにはいくつかのステータスがあり、すべてを公開前提としているわけではありません。

  • 標準公開プラグイン
    一般的に利用されることを想定しており、マニュアルにも掲載しています。

  • 制限付きプラグイン
    管理用・検証用・負荷軽減・特定のWIKI向けなど。広く公開すると誤用による負荷や不具合につながる可能性があるため、限定的に利用されています。

  • 廃止予定または移行対象のプラグイン
    内部的には動作しますが、将来的に終了や置き換えを予定しているものです。新規利用は推奨していないため、マニュアルには記載していません。

このような理由から、あえて全プラグインをマニュアルに掲載していない場合があります。
とくに「使えるけれど記載がない」ものは、安定性や互換性の観点から広く推奨できません。

一方で、マニュアル不足やアクセスのしづらさは課題と認識しています。
主要プラグインの追加や、リンク配置の改善についても課題と認識しており、できるところから順次対応していく予定です。

また、補足的な学び方として他のWIKIのソースを参考にするのも有効です。
実例を見ることで、マニュアルだけでは分かりにくい工夫や応用を理解しやすくなります。

マニュアルは今後も整備を進めますので、実例とあわせてご活用いただければ幸いです。

通報 ...
  • 17
    名前なし 2025/09/24 (水) 19:01:47 80f8f@65fa8 >> 16

    多用されると負荷が大きくなるため、あまり使用して欲しくない、一部のブラウザで動作しない、
    将来機能しなくなる可能性がある、将来廃止することを検討している、お試しで実装している、
    忙しくて記載する時間が取れない(さんぷるWikiの方には掲載されていたり※1、未完成下書きがあったり※2)…
    …そんなところだろうと思っていましたが、概ねそのようですね。

    ※1 font、jumplist、shadowheader、showrss2、table_edit、tag、tvote、など
    ※2 tomorrow_schedule、など

    問題は、全て運営側の一方的な都合であることと、
    ユーザーには非掲載の理由が不明なことです。
    (サービス業でありながら、どちらを向いて仕事しているかという話になってしまいます)

    標準プラグインと拡張プラグインに分けて掲載したいならそれでも構いませんが、
    マニュアルには、実装されている全てのプラグインを掲載いただき、
    非推奨の場合は、非推奨である旨とその理由、自己責任で使用する旨を記載すれば、
    よろしいのではないかと思います。

    現状ママでは、例えばcontentsxやinclude2、includexは積極使用OKなのか、
    それとも使用はできるだけ控えた方が良いのかすら(その理由を含めて)判断できませんが、
    例えば「MenuBarでの使用は、負荷が大きくなるため非推奨」など具体的なアドバイスが書かれていれば、
    大いに役立つだろうと思われます。

    20
    副管理人(WoTBWiki) 2025/10/02 (木) 21:12:43 修正 >> 17

    賛同します。使えるにも関わらずマニュアルに掲載されていないと混乱を招く原因になります。(一般論としてマニュアルに記載されていないのに使えるというのも意味不明ですし。)
    仮に非推奨や今後廃止される予定があるならその旨記載されていればすんなりと受け入れることができます。(むしろ廃止予定ものを明示することで該当Wikiで早めに対処することが可能です。)

    また、他のWikiを参考にすればいいというのもいささか乱暴に思えます。マニュアルを整備したうえで活用事例として紹介する分には自然ですが、不完全なマニュアルのまま「他のWikiを参考にしてください」はいかがなものでしょうか。言い方は悪くなってしまいますが、現在の姿勢はユーザーに対する透明性に欠けるものだと感じます。

要望は具体的な提案や理由を書いて下さい。
×